Skip to content

codefresh-io/cli

Folders and files

NameName
Last commit message
Last commit date
Feb 12, 2019
Jan 29, 2018
May 14, 2020
Jun 8, 2020
Jan 4, 2018
Apr 22, 2019
Dec 19, 2018
Dec 28, 2018
May 12, 2020
Jan 2, 2018
Dec 22, 2019
Jan 30, 2019
Dec 19, 2018
Apr 14, 2020
Apr 14, 2020
May 21, 2020
Jun 8, 2020
May 19, 2020
Jun 4, 2020

Repository files navigation

Codefresh-cli

Build: Codefresh build status Release: Codefresh build status

Codefresh CLI provides a full and flexible interface to interact with Codefresh.

demo

Install

In case you have node.js installed you can easily install with NPM.

npm install -g codefresh

For other installation possibilities check out the installation documentation.

Authenticate

Generate a new api key from the account settings page.

codefresh auth create-context --api-key {{API_KEY}}

Usage

codefresh <command>

Commands:
  codefresh completion             generate bash completion script
  codefresh tag <id> [tags..]      Add an image tag.
  codefresh untag <id> [tags..]    Untag an image.
  codefresh annotate               Annotate a resource with labels.
  codefresh patch                  Patch a resource by filename or stdin.
  codefresh auth                   Manage authentication contexts.
  codefresh create                 Create a resource from a file or stdin.
  codefresh delete                 Delete a resource by file or resource name.
  codefresh generate               Generate resources as Kubernetes image pull secret and Codefresh Registry token.
  codefresh get                    Display one or many resources.
  codefresh replace                Replace a resource by filename.
  codefresh version                Print version.
  codefresh logs <id>              Show logs of a build.
  codefresh restart <id>           Restart a build by its id.
  codefresh terminate <id>         Terminate a build by its id.
  codefresh wait <id..>            Wait until a condition will be met on a build.
  codefresh run <name>             Run a pipeline by id or name and attach the created workflow logs.
  codefresh delete-release [name]  Delete a helm release from a kubernetes cluster.
  codefresh install-chart          Install or upgrade a Helm chart Repository flag can be either absolute url or saved repository in Codefresh.
  codefresh helm-promotion         Promote a Helm release in another environment.
  codefresh test-release [name]    Test a helm release.

Options:
  --cfconfig  Custom path for authentication contexts config file  [default: "/Users/itaigendler/.cfconfig"]
  --help      Show help  [boolean]

Documentation

For more information please visit the official CLI documentation site.