{
"name": "circleci",
"description": "CircleCI CLI",
"subcommands": [
{
"name": "completion",
"description": "Generate shell completion scripts",
"subcommands": [
{
"name": "bash",
"description": "Generate bash completion scripts"
},
{
"name": "zsh",
"description": "Generate zsh completion scripts"
}
]
},
{
"name": "config",
"description": "Operate on build config files",
"subcommands": [
{
"name": "pack",
"description": "Pack CircleCI config files into a single file"
},
{
"name": "process",
"description": "Validate and display extended config"
},
{
"name": "validate",
"description": "Checks that config is valid"
}
]
},
{
"name": "context",
"description": "Secure and share environment variables across projects",
"subcommands": [
{
"name": "create",
"description": "Create a new context",
"args": [
{
"name": "vcs-type",
"description": "Your VCS provider, can be either 'github' or 'bitbucket'",
"suggestions": [
"github",
"bitbucket"
]
},
{
"name": "org-name",
"description": "The name of your organization"
},
{
"name": "context-name",
"description": "The name for your context"
}
]
},
{
"name": "delete",
"description": "Delete the named context",
"args": [
{
"name": "vcs-type",
"description": "Your VCS provider, can be either 'github' or 'bitbucket'",
"suggestions": [
"github",
"bitbucket"
]
},
{
"name": "org-name",
"description": "The name of your organization"
},
{
"name": "context-name",
"description": "The name for your context"
}
]
},
{
"name": "list",
"description": "List all contexts",
"args": [
{
"name": "vcs-type",
"description": "Your VCS provider, can be either 'github' or 'bitbucket'",
"suggestions": [
"github",
"bitbucket"
]
},
{
"name": "org-name",
"description": "The name of your organization"
}
]
},
{
"name": "remove-secret",
"description": "Remove environment variable from a context",
"args": [
{
"name": "vcs-type",
"description": "Your VCS provider, can be either 'github' or 'bitbucket'",
"suggestions": [
"github",
"bitbucket"
]
},
{
"name": "org-name",
"description": "The name of your organization"
},
{
"name": "context-name",
"description": "The name for your context"
},
{
"name": "secret name",
"description": "The name of the env variable to remove"
}
]
},
{
"name": "show",
"description": "Show a context",
"args": [
{
"name": "vcs-type",
"description": "Your VCS provider, can be either 'github' or 'bitbucket'",
"suggestions": [
"github",
"bitbucket"
]
},
{
"name": "org-name",
"description": "The name of your organization"
},
{
"name": "context-name",
"description": "The name for your context"
}
]
},
{
"name": "store-secret",
"description": "Store environment variables",
"args": [
{
"name": "vcs-type",
"description": "Your VCS provider, can be either 'github' or 'bitbucket'",
"suggestions": [
"github",
"bitbucket"
]
},
{
"name": "org-name",
"description": "The name of your organization"
},
{
"name": "context-name",
"description": "The name for your context"
},
{
"name": "secret name",
"description": "The name of the env variable to store"
}
]
}
]
},
{
"name": "diagnostic",
"description": "Check the status of your CircleCI CLI"
},
{
"name": "follow",
"description": "Attempt to follow the project for the current git repo"
},
{
"name": "help",
"description": "Help about any command"
},
{
"name": "local",
"description": "Debug jobs on the local machine",
"subcommands": [
{
"name": "execute",
"description": "Run a job in a container on the local machine"
}
]
},
{
"name": "namespace",
"description": "Operate on namespaces",
"subcommands": [
{
"name": "create",
"description": "Create a namespace"
}
]
},
{
"name": "open",
"description": "Open the current project in the browser"
},
{
"name": "orb",
"description": "Operate on orbs",
"subcommands": [
{
"name": "add-to-category",
"description": "Add an orb to a category",
"args": [
{
"name": "namespace/orb",
"description": "The namespace and orb to add to a category"
},
{
"name": "category name",
"description": "The name of the category to add the orb to, in quotes"
}
]
},
{
"name": "create",
"description": "Create an orb in a namespace",
"options": [
{
"names": [
"--private"
],
"description": "Specify that this orb is for private use within your org, unlisted from the public registry"
}
],
"args": [
{
"name": "namespace/orb",
"description": "Create an orb in the specified namespace"
}
]
},
{
"name": "info",
"description": "Show metadata of an orb",
"args": [
{
"name": "orb",
"description": "The namespace and orb to show metadata for"
}
]
},
{
"name": "init",
"description": "Initialize a new orb",
"options": [
{
"names": [
"--private"
],
"description": "Specify that this orb is for private use within your org, unlisted from the public registry"
}
],
"args": [
{
"name": "path",
"description": "The /path/to/myProject-orb"
}
]
},
{
"name": "list",
"description": "List orbs",
"options": [
{
"names": [
"--private"
],
"description": "Specify that this orb is for private use within your org, unlisted from the public registry"
},
{
"names": [
"--sort"
],
"description": "Specify the sorting",
"takes_arg": true,
"arg": {
"suggestions": [
"builds",
"projects",
"orgs"
]
}
},
{
"names": [
"-u",
"--uncertified"
],
"description": "Include uncertified orbs"
}
],
"args": [
{
"name": "namespace",
"description": "The namespace used for the orb (i.e. circleci)"
}
]
},
{
"name": "list-categories",
"description": "List orb categories"
},
{
"name": "pack",
"description": "Pack an orb with local scripts",
"args": [
{
"name": "path",
"description": "The /path/to/myProject-orb"
}
]
},
{
"name": "process",
"description": "Validate an orb and print its form after all pre-registration processing is complete",
"args": [
{
"name": "path",
"description": "The path to your orb (use '-' for STDIN)"
}
]
},
{
"name": "publish",
"description": "Publish an orb to the registry",
"args": [
{
"name": "path",
"description": "The /path/to/myProject-orb"
},
{
"name": "orb",
"description": "A fully-qualified reference to an orb, i.e. namespace/orb@version"
}
]
},
{
"name": "remove-from-category",
"description": "Remove an orb from a category",
"args": [
{
"name": "namespace/orb",
"description": "The namespace and orb to add to a category"
},
{
"name": "category name",
"description": "The name of the category to add the orb to, in quotes"
}
]
},
{
"name": "source",
"description": "Show source code of an orb",
"args": [
{
"name": "orb",
"description": "A fully-qualified reference to an orb, i.e. namespace/orb@version"
}
]
},
{
"name": "unlist",
"description": "Disable/enable an orb's listing in the registry",
"args": [
{
"name": "namespace/orb",
"description": "The namespace and orb to unlist/list from the registry"
},
{
"name": "condition",
"description": "Use either true|false",
"suggestions": [
"true",
"false"
]
}
]
},
{
"name": "validate",
"description": "Validate an orb.yml",
"args": [
{
"name": "path",
"description": "The /path/to/myProject-orb"
}
]
}
]
},
{
"name": "policy",
"description": "Manage security policies",
"subcommands": [
{
"name": "decide",
"description": "Make a decision",
"options": [
{
"names": [
"--input"
],
"description": "Path to input file, i.e. ./.circleci/config.yml",
"takes_arg": true,
"arg": {
"name": "string"
}
},
{
"names": [
"--metafile"
],
"description": "Path to decision metadata file",
"takes_arg": true,
"arg": {
"name": "string"
}
},
{
"names": [
"--owner-id"
],
"description": "The id of the policy's owner",
"takes_arg": true,
"arg": {
"name": "string"
}
},
{
"names": [
"--strict"
],
"description": "Return non-zero status code for decision resulting in HARD_FAIL"
},
{
"names": [
"--context"
],
"description": "Policy context for decision, default is 'config'",
"takes_arg": true,
"arg": {
"name": "string"
}
}
],
"args": [
{
"name": "path",
"description": "Policy file or directory path"
}
]
},
{
"name": "diff",
"description": "Get diff between local and remote policy bundles",
"options": [
{
"names": [
"--context"
],
"description": "Policy context for decision, default is 'config'",
"takes_arg": true,
"arg": {
"name": "string"
}
},
{
"names": [
"--owner-id"
],
"description": "The id of the policy's owner",
"takes_arg": true,
"arg": {
"name": "string"
}
}
],
"args": [
{
"name": "policy_dir_path",
"description": "Policy file or directory path"
}
]
},
{
"name": "eval",
"description": "Perform raw opa evaluation locally",
"options": [
{
"names": [
"--input"
],
"description": "Path to input file, i.e. ./.circleci/config.yml",
"takes_arg": true,
"arg": {
"name": "string"
}
},
{
"names": [
"--metafile"
],
"description": "Path to decision metadata file",
"takes_arg": true,
"arg": {
"name": "string"
}
},
{
"names": [
"--query"
],
"description": "Policy decision query, default is 'data'",
"takes_arg": true,
"arg": {
"name": "string"
}
}
],
"args": [
{
"name": "policy_dir_path",
"description": "Policy file or directory path"
}
]
},
{
"name": "fetch",
"description": "Fetch policy bundle (or a single policy)",
"options": [
{
"names": [
"--context"
],
"description": "Policy context for decision, default is 'config'",
"takes_arg": true,
"arg": {
"name": "string"
}
},
{
"names": [
"--owner-id"
],
"description": "The id of the policy's owner"
}
],
"args": [
{
"name": "policy name",
"description": "Name of policy to fetch"
}
]
},
{
"name": "logs",
"description": "Get policy decision logs / decision log (or policy bundle) by decision ID",
"options": [
{
"names": [
"--after"
],
"description": "Filter decision logs triggered AFTER this datetime",
"takes_arg": true,
"arg": {
"name": "string"
}
},
{
"names": [
"--before"
],
"description": "Filter decision logs triggered BEFORE this datetime",
"takes_arg": true,
"arg": {
"name": "string"
}
},
{
"names": [
"--branch"
],
"description": "Filter decision logs based on branch name",
"takes_arg": true,
"arg": {
"name": "string"
}
},
{
"names": [
"--context"
],
"description": "Policy context for decision, default is 'config'",
"takes_arg": true,
"arg": {
"name": "string"
}
},
{
"names": [
"--owner-id"
],
"description": "The id of the policy's owner",
"takes_arg": true,
"arg": {
"name": "string"
}
},
{
"names": [
"--out"
],
"description": "Specify output file name",
"takes_arg": true,
"arg": {
"name": "string"
}
},
{
"names": [
"--policy-bundle"
],
"description": "Get only the policy bundle for given decisionID"
},
{
"names": [
"--project-id"
],
"description": "Filter decision logs based on project-id",
"takes_arg": true,
"arg": {
"name": "string"
}
},
{
"names": [
"--status"
],
"description": "Filter decision logs based on their status",
"takes_arg": true,
"arg": {
"name": "string"
}
}
],
"args": [
{
"name": "decision ID",
"description": "Decision ID to get logs for"
}
]
},
{
"name": "push",
"description": "Push policy bundle (or a single policy)",
"options": [
{
"names": [
"--context"
],
"description": "Policy context for decision, default is 'config'",
"takes_arg": true,
"arg": {
"name": "string"
}
},
{
"names": [
"--owner-id"
],
"description": "The id of the policy's owner",
"takes_arg": true,
"arg": {
"name": "string"
}
},
{
"names": [
"--no-prompt"
],
"description": "Removes the prompt"
}
],
"args": [
{
"name": "policy_dir_path",
"description": "Policy file or directory path"
}
]
},
{
"name": "settings",
"description": "Get/set policy decision settings (To read settings: run command without any settings flags)",
"options": [
{
"names": [
"--context"
],
"description": "Policy context for decision, default is 'config'"
},
{
"names": [
"--enabled"
],
"description": "Enable/disable policy decision evaluation in build pipeline",
"takes_arg": true,
"arg": {
"name": "boolean",
"suggestions": [
"true",
"false"
]
}
},
{
"names": [
"--owner-id"
],
"description": "The id of the policy's owner",
"takes_arg": true,
"arg": {
"name": "string"
}
}
]
}
]
},
{
"name": "runner",
"description": "Operate on runners",
"subcommands": [
{
"name": "instance",
"description": "Operate on runner instances"
},
{
"name": "resource-class",
"description": "Operate on runner resource-classes"
},
{
"name": "token",
"description": "Operate on runner tokens"
}
]
},
{
"name": "setup",
"description": "Setup CLI with your credentials"
},
{
"name": "update",
"description": "Update and switch to new CLI version",
"subcommands": [
{
"name": "check",
"description": "Check for new CLI version"
},
{
"name": "install",
"description": "Install new CLI version"
}
]
},
{
"name": "version",
"description": "Display CircleCI CLI version"
}
],
"options": [
{
"names": [
"--help",
"-h"
],
"description": "Show help for CircleCI"
},
{
"names": [
"--skip-update-check"
],
"description": "Skip update check before every command"
}
]
}