circleci init

Initialize a new CircleCI project

Synopsis

Creates a new project, pipeline, and trigger in one easy step.

This command will guide you through setting up a complete CircleCI project by: 1. Creating a new project in your CircleCI organization 2. Setting up a pipeline definition with your repository 3. Creating a trigger to automatically run the pipeline

Examples: # Interactive mode - prompts for all required values circleci init

# With org slug argument circleci init github/myorg circleci init circleci/myorg

# With flags to skip some prompts circleci init github/myorg –project-name myproject –repo-id 123456

# Full specification with all flags circleci init github/myorg –project-name myproject
–pipeline-name my-pipeline –repo-id 123456 –trigger-name my-trigger

circleci init [org-slug] [flags]

Flags

      --checkout-ref string           Git ref to use when checking out code (only needed if different from trigger repo)
      --config-ref string             Git ref to use when fetching config (only needed if different from trigger repo)
      --config-repo-id string         GitHub repository ID where the CircleCI config file is located (defaults to same as repo-id)
      --event-preset string           Event preset to filter triggers. Valid values: all-pushes, only-tags, default-branch-pushes, only-build-prs, only-open-prs, only-merged-prs, only-ready-for-review-prs, only-labeled-prs, only-build-pushes-to-non-draft-prs
      --file-path string              Path to the CircleCI config file (default: .circleci/config.yml)
  -h, --help                          help for init
      --org-name string               Organization name or slug
      --pipeline-description string   Description of the pipeline
      --pipeline-name string          Name of the pipeline to create
      --project-name string           Name of the project to create
      --repo-id string                GitHub repository ID of the codebase
      --trigger-description string    Description of the trigger
      --trigger-name string           Name of the trigger to create
      --vcs-type string               Version control system type (e.g., 'github', 'circleci')

Flags inherited from parent commands

      --host string         URL to your CircleCI host, also CIRCLECI_CLI_HOST (default "https://circleci.com")
      --skip-update-check   Skip the check for updates check run before every command. (default true)
      --token string        your token for using CircleCI, also CIRCLECI_CLI_TOKEN

SEE ALSO