Documentation structure for LLMs (llms.txt)
CircleCI Logo

Hello world

9 hours ago
Cloud Server

This page provides configuration examples to get started with a basic pipeline using any execution environment.

Prerequisites

  • An account on your CircleCI Server instance, connected to your code.

  • A code repository you want to build on CircleCI.

  • Follow the Set Up a Project steps to connect your repository to CircleCI. You can then use the examples below to configure a basic pipeline using any execution environment.

Using Docker? Authenticating Docker pulls from image registries is recommended when using the Docker execution environment. Authenticated pulls allow access to private Docker images, and may also grant higher rate limits, depending on your registry provider. For further information, see Using Docker Authenticated Pulls.

Echo hello world on CircleCI Server

To build in a macOS execution environment on server use Self-Hosted Runner.

These examples add a job called hello-job that prints hello world to the console.

  • Docker

  • Linux VM

  • Windows

  • Arm

The job hello-job spins up a container running a pre-built CircleCI Docker image for Node. Refer to Using the Docker Execution Environment page for more information.

version: 2.1

jobs:
  hello-job:
    docker:
      - image: cimg/node:17.2.0 # the primary container, where your job's commands are run
    steps:
      - checkout # check out the code in the project directory
      - run: echo "hello world" # run the `echo` command

workflows:
  my-workflow:
    jobs:
      - hello-job

The job hello-job spins up a Linux vir†ual machine running a Ubuntu machine image. Refer to Using the Linux VM Execution Environment page for more information.

version: 2.1

jobs:
  hello-job:
    machine:
      image: default
    steps:
      - checkout # check out the code in the project directory
      - run: echo "hello world" # run the `echo` command

workflows:
  my-workflow:
    jobs:
      - hello-job

The job hello-job spins up a Windows virtual machine using the default executor specified by the Windows orb. Refer to Using the Windows Execution Environment page for more information.

version: 2.1

jobs:
  hello-job:
    machine:
      image: windows-default

    steps:
      # Commands are run in a Windows virtual machine environment
      - checkout
      - run: Write-Host 'Hello, Windows'

workflows:
  my-workflow:
    jobs:
      - hello-job

The job hello-job spins up an Arm (Ubuntu 22.04) virtual machine. Refer to Using the Arm VM Execution Environment page for more information.

version: 2.1

jobs:
  hello-job:
    machine:
      image: arm-default
    resource_class: arm.medium
    steps:
      - checkout # check out the code in the project directory
      - run: echo "hello world" # run the `echo` command

workflows:
  my-workflow:
    jobs:
      - hello-job
If you get a No Config Found error, it may be that you used .yaml file extension. Be sure to use .yml file extension to resolve this error.

Next steps

  • See the Concepts page for a summary of CircleCI-specific concepts.

  • Refer to the Workflows page for examples of orchestrating job runs with concurrent, sequential, scheduled, and manual approval workflows.

  • Find complete reference information for all keys and execution environments in the CircleCI Configuration Reference.