|
| 1 | +#Codefresh-cli |
1 | 2 | []( https://g.codefresh.io/repositories/codefresh-io/cli/builds?filter=trigger:build;branch:master;service:5a4c94b54e6e5f0001c4f913~build)
|
| 3 | +Codefresh CLi provides a full and flexible interface to interact with Codefresh. |
2 | 4 |
|
3 |
| -Visit the official <a href="http://cli.codefresh.io" target="_blank">CLI documentation</a> site. |
| 5 | + |
| 6 | + |
| 7 | +##Install |
| 8 | +In case you have node.js installed you can easily install with NPM. |
| 9 | + |
| 10 | +`npm install -g codefresh` |
| 11 | + |
| 12 | +For other installation possibilities check out the <a href="http://cli.codefresh.io/installation" target="_blank">installation documentation</a>. |
| 13 | + |
| 14 | +##Authenticate |
| 15 | + |
| 16 | + |
| 17 | +##Usage |
| 18 | +```$xslt |
| 19 | +codefresh <command> |
| 20 | +
|
| 21 | +Commands: |
| 22 | + codefresh completion generate bash completion script |
| 23 | + codefresh tag <id> [tags..] Add an image tag |
| 24 | + codefresh annotate Annotate a resource with labels |
| 25 | + codefresh patch Patch a resource by filename or stdin |
| 26 | + codefresh auth Manage authentication contexts |
| 27 | + codefresh create Create a resource from a file or from stdin |
| 28 | + codefresh delete Delete a resource by file or resource name |
| 29 | + codefresh get Display one or many resources |
| 30 | + codefresh replace Replace a resource by filename or stdin |
| 31 | + codefresh version Print version |
| 32 | + codefresh logs <id> Show logs of a build |
| 33 | + codefresh restart <id> Restart a build by its id |
| 34 | + codefresh terminate <id> Terminate a build by its id |
| 35 | + codefresh wait <id..> Wait until a condition will be met on a build |
| 36 | + codefresh run <id> Run a pipeline and attach the created workflow logs. |
| 37 | + Returns an exit code according to the workflow finish status (Success: 0, Error: 1, Terminated: 2). |
| 38 | + codefresh delete-release [name] Delete a helm release |
| 39 | + codefresh install-chart Install or upgrade a Helm chart |
| 40 | + Repository flag can be either absolute url or saved repository in Codefresh |
| 41 | + codefresh test-release [name] Test a helm release |
| 42 | + |
| 43 | +Options: |
| 44 | + --cfconfig Custom path for authentication contexts config file [default: "/Users/itaigendler/.cfconfig"] |
| 45 | + --help Show help [boolean] |
| 46 | +``` |
| 47 | + |
| 48 | +##Documentation |
| 49 | +For more information please visit the official <a href="http://cli.codefresh.io" target="_blank">CLI documentation</a> site. |
0 commit comments