Skip to content

codefresh-plugins/cli

 
 

Repository files navigation

Codefresh-cli

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 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 from stdin
  codefresh delete                 Delete a resource by file or resource name
  codefresh get                    Display one or many resources
  codefresh replace                Replace a resource by filename or stdin
  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 <id>               Run a pipeline and attach the created workflow logs.
                                   Returns an exit code according to the workflow finish status (Success: 0, Error: 1, Terminated: 2).
  codefresh delete-release [name]  Delete a helm release
  codefresh install-chart          Install or upgrade a Helm chart
                                               Repository flag can be either absolute url or saved repository in Codefresh
  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.

About

Codefresh CLI

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • JavaScript 99.5%
  • Other 0.5%