### CircleCI Local CLI Documentation Source: https://circleci.com/docs/local-cli/ Guides on installing, configuring, and using the CircleCI local command-line interface for local development and testing of CircleCI configurations. ```cli Install and configure the CircleCI local CLI: /docs/local-cli/ How to use the CircleCI local CLI: /docs/how-to-use-the-circleci-local-cli/ ``` -------------------------------- ### CircleCI Local CLI Usage Source: https://circleci.com/docs/vs-code-extension-overview/ Guides on how to install, configure, and utilize the CircleCI local command-line interface. This tool allows developers to test CircleCI configurations and workflows on their local machine. ```APIDOC CircleCI Local CLI: Install and Configure: - Provides instructions on downloading and setting up the CircleCI local CLI. - Covers authentication with CircleCI accounts. How to Use: - Details commands for running builds locally. - Explains how to simulate different environments and test configurations. - Includes examples for common workflows like `circleci build`, `circleci step`, and `circleci local execute`. ``` -------------------------------- ### Alternative CircleCI CLI Install (Mac/Linux - Script) Source: https://circleci.com/docs/local-cli/ Installs the CircleCI CLI by downloading and executing an installation script from GitHub. This method is suitable for users on macOS and Linux who prefer not to use Homebrew. ```shell curl -fLSs https://raw.githubusercontent.com/CircleCI-Public/circleci-cli/main/install.sh | bash ``` ```shell curl -fLSs https://raw.githubusercontent.com/CircleCI-Public/circleci-cli/main/install.sh | sudo bash ``` ```shell curl -fLSs https://raw.githubusercontent.com/CircleCI-Public/circleci-cli/main/install.sh | DESTDIR=/opt/bin bash ``` -------------------------------- ### Install CircleCI CLI via Script (Mac/Linux) Source: https://circleci.com/docs/local-cli/ Installs the CircleCI CLI on macOS and Linux by downloading and executing an installation script. The CLI is typically installed to \/usr\/local\/bin. ```shell curl -fLSs https://raw.githubusercontent.com/CircleCI-Public/circleci-cli/main/install.sh | bash ``` -------------------------------- ### Install CircleCI CLI via Script (Mac/Linux to Alternate Path) Source: https://circleci.com/docs/local-cli/ Installs the CircleCI CLI on macOS and Linux by downloading and executing an installation script, specifying an alternate installation directory using the DESTDIR environment variable. ```shell curl -fLSs https://raw.githubusercontent.com/CircleCI-Public/circleci-cli/main/install.sh | DESTDIR=/opt/bin bash ``` -------------------------------- ### Linux Install with Snap Source: https://circleci.com/docs/local-cli/ Installs the CircleCI CLI and Docker using Snap packages on Linux. This method also configures Docker integration and auto-updates for the CLI. ```shell sudo snap install docker circleci sudo snap connect circleci:docker docker ``` -------------------------------- ### Install CircleCI CLI on Linux using Snap Source: https://circleci.com/docs/local-cli/ Installs the CircleCI CLI, Docker, and associated features using Snap packages. This method ensures security and auto-updates. Note that the Docker command will use the Snap version, and files can only be accessed within $HOME. ```shell sudo snap install docker circleci sudo snap connect circleci:docker docker ``` -------------------------------- ### Install CircleCI CLI with Chocolatey (Windows) Source: https://circleci.com/docs/local-cli/ Installs the CircleCI CLI on Windows using the Chocolatey package manager. The `-y` flag automatically confirms any prompts during installation. ```shell choco install circleci-cli -y ``` -------------------------------- ### CircleCI CLI: Verify Self-Hosted Runner Installation Source: https://circleci.com/docs/local-cli/ Steps to verify namespaces and resource classes for a self-hosted runner installation using the CircleCI CLI. This helps ensure the runner is correctly configured. ```APIDOC circleci runner verify --namespace --resource-class - Verifies the configuration of a self-hosted runner. - Usage: circleci runner verify --namespace my-namespace --resource-class my-runner-class - Parameters: - --namespace : The namespace for the runner. - --resource-class : The resource class of the runner. - Returns: Status indicating if the runner configuration is valid. ``` -------------------------------- ### Install CircleCI CLI on Windows with Chocolatey Source: https://circleci.com/docs/local-cli/ Installs the CircleCI CLI on Windows using the Chocolatey package manager. The `-y` flag automatically confirms any prompts during installation. ```Shell choco install circleci-cli -y ``` -------------------------------- ### Install CircleCI CLI on Linux with Snap Source: https://circleci.com/docs/local-cli/ Installs the CircleCI CLI and Docker using Snap packages. This method ensures Docker uses the Snap version and restricts file access to the user's home directory for security. ```Shell sudo snap install docker circleci sudo snap connect circleci:docker docker ``` -------------------------------- ### CircleCI Pipeline Setup - GitHub OAuth App Source: https://circleci.com/docs/getting-started/ Guidance on setting up a CI/CD pipeline for a newly created project in CircleCI. This includes connecting code, preparing a config file, and reviewing triggers. ```text Follow the in-app instructions to set up your pipeline, including connecting your code, preparing a config file, and reviewing triggers. For a more detailed look at this process, see the "Create a project" guide. ``` -------------------------------- ### Alternative CircleCI CLI Installation (Mac/Linux) Source: https://circleci.com/docs/local-cli/ Installs the CircleCI CLI using a shell script downloaded via curl. This method is suitable for Mac and Linux users. You can specify an installation directory using DESTDIR or use sudo if write permissions are an issue. ```Shell curl -fLSs https://raw.githubusercontent.com/CircleCI-Public/circleci-cli/main/install.sh | bash ``` ```Shell curl -fLSs https://raw.githubusercontent.com/CircleCI-Public/circleci-cli/main/install.sh | sudo bash ``` ```Shell curl -fLSs https://raw.githubusercontent.com/CircleCI-Public/circleci-cli/main/install.sh | DESTDIR=/opt/bin bash ``` -------------------------------- ### CircleCI Config Selection - GitLab/Bitbucket Data Center Source: https://circleci.com/docs/getting-started/ Guidance on selecting or creating a config.yml file during the project setup process for GitLab and Bitbucket Data Center integrations in CircleCI. ```text In the "Select your config.yml file" modal, select... ``` -------------------------------- ### Configure CircleCI CLI Source: https://circleci.com/docs/local-cli/ Command to initiate the CircleCI CLI setup process. This involves generating a CircleCI API token and configuring connection settings for CircleCI cloud or server. ```bash circleci setup ``` -------------------------------- ### Install CircleCI CLI with Chocolatey (Windows) Source: https://circleci.com/docs/local-cli/ Installs the CircleCI CLI on Windows using the Chocolatey package manager. The '-y' flag automatically confirms any prompts during installation. ```shell choco install circleci-cli -y ``` -------------------------------- ### Install CircleCI CLI with Homebrew (Ignore Dependencies) Source: https://circleci.com/docs/local-cli/ Installs the CircleCI CLI using Homebrew, specifically ignoring any dependency conflicts. This can be useful if you have specific version requirements for dependencies. ```shell brew install --ignore-dependencies circleci ``` -------------------------------- ### Install CircleCI MCP Server with Smithery Source: https://circleci.com/mcp Command to install the CircleCI MCP server package using the Smithery CLI, specifying the client as 'claude'. This is a direct installation command rather than a configuration file. ```shell npx -y @smithery/cli install @CircleCI-Public/mcp-server-circleci --client claude ``` -------------------------------- ### CircleCI CLI: Validate Server Installation Source: https://circleci.com/docs/local-cli/ Instructions on using the 'Reality Check' tool via the CircleCI CLI to validate a CircleCI server installation, specifically for GitHub Enterprise. ```APIDOC circleci server validate --config - Validates the CircleCI server installation using Reality Check. - Usage: circleci server validate --config server-config.yml - Parameters: - --config : Path to the configuration file for validation. - Returns: Validation results and any detected issues. ``` -------------------------------- ### Install CircleCI CLI via Script (Mac/Linux with Sudo) Source: https://circleci.com/docs/local-cli/ Installs the CircleCI CLI on macOS and Linux using a script, with elevated privileges (sudo) if write permissions are insufficient for \/usr\/local\/bin. ```shell curl -fLSs https://raw.githubusercontent.com/CircleCI-Public/circleci-cli/main/install.sh | sudo bash ``` -------------------------------- ### Install CircleCI CLI on macOS with Homebrew Source: https://circleci.com/docs/local-cli/ Installs the CircleCI CLI using the Homebrew package manager. If Docker for Mac is already installed, you can use the `--ignore-dependencies` flag. ```Shell brew install circleci ``` ```Shell brew install --ignore-dependencies circleci ``` -------------------------------- ### Install CircleCI CLI with Homebrew (macOS/Linux) Source: https://circleci.com/docs/local-cli/ Installs the CircleCI CLI using the Homebrew package manager. This is a common method for macOS and Linux users. It ensures the CLI is installed with all necessary dependencies. ```shell brew install circleci ``` ```shell brew install --ignore-dependencies circleci ``` -------------------------------- ### Example Natural Language Query Source: https://circleci.com/mcp Demonstrates how to query the CircleCI MCP Server using natural language to understand build failures. ```plaintext why did my last build fail? ``` -------------------------------- ### Configure CircleCI CLI Source: https://circleci.com/docs/local-cli/ Before using the CircleCI CLI, you must configure it with a CircleCI API token obtained from the Personal API Token tab. This command initiates an interactive setup process. ```shell circleci setup ``` -------------------------------- ### CircleCI VS Code Extension Source: https://circleci.com/docs/local-cli/ Information on the VS Code extension for CircleCI, covering its overview and getting started guide to enhance development workflows within the VS Code environment. ```vscode VS Code extension overview: /docs/vs-code-extension-overview/ Get started with the VS Code extension: /docs/get-started-with-the-vs-code-extension/ ``` -------------------------------- ### CircleCI Commit and Run - GitHub OAuth App Source: https://circleci.com/docs/getting-started/ Instructions for committing the pipeline configuration and initiating the first build after setting up a project and pipeline in CircleCI. ```text Once pipeline setup is complete, commit your config (if not already present in your repo) and build. Review your project details and select "Commit config and run". ``` -------------------------------- ### CircleCI Project Creation - GitLab/Bitbucket Data Center Source: https://circleci.com/docs/getting-started/ Steps for creating a new project within the CircleCI web application when integrating with GitLab or Bitbucket Data Center. ```text 1. In the CircleCI web app, select "Projects" from the sidebar. 2. Click "Create Project". 3. Select the repository you would like to connect from the dropdown. Note: If options are not visible, use the org selector in the top left corner to find the correct organization. ``` -------------------------------- ### macOS Install with Homebrew Source: https://circleci.com/docs/local-cli/ Installs the CircleCI CLI on macOS using the Homebrew package manager. This is a recommended method for macOS users. ```bash brew install circleci/circleci/circleci ``` -------------------------------- ### GitHub OAuth App Project Slug Example Source: https://circleci.com/docs/getting-started/ Illustrates the human-readable project slug format used for GitHub OAuth applications within CircleCI. This slug helps identify specific projects for integration. ```text github/circleci/circleci-demo-workflows ``` -------------------------------- ### Update CircleCI CLI (Linux/Windows) Source: https://circleci.com/docs/local-cli/ Updates the CircleCI CLI to the latest version for Linux and Windows installations. This command fetches and installs the newest release. ```shell circleci update ``` -------------------------------- ### Segment Analytics Initialization Source: https://circleci.com/docs/local-cli/ Initializes the Segment analytics library. It loads the analytics snippet, defines available methods, and configures integrations like Amplitude and Postgres. ```javascript !function(){var analytics=window.analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","reset","group","track","ready","alias","debug","page","once","off","on","addSourceMiddleware","addIntegrationMiddleware","setAnonymousId","addDestinationMiddleware"];analytics.factory=function(e){return function(){var t=Array.prototype.slice.call(arguments);t.unshift(e);analytics.push(t);return analytics}};for(var e=0;e