File tree Expand file tree Collapse file tree 5 files changed +25
-31
lines changed Expand file tree Collapse file tree 5 files changed +25
-31
lines changed Original file line number Diff line number Diff line change 11[ ![ Codefresh build status] ( https://g.codefresh.io/api/badges/build?repoOwner=codefresh-io&repoName=cli&branch=master&pipelineName=build&accountName=codefresh-inc&type=cf-1 )] ( https://g.codefresh.io/repositories/codefresh-io/cli/builds?filter=trigger:build;branch:master;service:5a4c94b54e6e5f0001c4f913~build )
2- # Codefresh CLI
3- This packages provides a CLI for interacting with Codefresh <br />
4- You can also requires this module to be used in node.js and the browser
52
6- # Installation Instructions
7- ## Install from official releases
8- <a href =" https://github.com/codefresh-io/cli/releases " target =" _blank " >Official Releases</a >
9-
10- ## Install via npm
11- ` npm install -g codefresh `
12-
13- ## Install via yarn
14- ` yarn global add codefresh `
15- ### Updaing to latest version
16- ` yarn global upgrade codefresh `
17-
18- # Installing bash completions
19- Run ` /usr/local/bin/codefresh completion >> ~/.bashrc ` . <br />
20- If you are on OSX run ` /usr/local/bin/codefresh completion >> ~/.bash_profile `
21-
22- # Getting Started
23- In order to start working with the cli you will need to update the authentication configuration. <br />
24- Generate a new API key through the <a href =" https://g.codefresh.io/account/tokens " target =" _blank " >account settings</a > page. <br />
25- Once you have the API key, create a new authentication context: ` codefresh auth create-context --api-key {API_KEY} `
3+ Visit the official <a href =" http://cli.codefresh.io " target =" _blank " >CLI documentation</a > site.
Original file line number Diff line number Diff line change 11---
2- weight : 10
3- title : API Reference
2+ weight : 20
3+ title : Installation
44---
55
66# Installation
Original file line number Diff line number Diff line change 1+ ---
2+ weight : 30
3+ title : Authentication
4+ ---
5+
6+ # Authentication
7+
8+ ## Basic Usage
9+ In order to start working with the cli you will need to update the authentication configuration. <br />
10+ Generate a new API key through the <a href =" https://g.codefresh.io/account/tokens " target =" _blank " >account settings</a > page. <br />
11+ Once you have the API key, create a new authentication context: ` codefresh auth create-context --api-key {API_KEY} `
12+
13+ ## Advanced Usage
Original file line number Diff line number Diff line change 11---
22weight : 10
3- title : API Reference
3+ title : Introduction
44---
55
66# Introduction
7-
87Welcome to Codefresh's official CLI documentation!
98
10- ## Installation
11-
12- ### From Binaries
9+ Codefresh CLI provides a full and flexible interface to interact with Codefresh.<br >
10+ The CLI can be used to achieve the following:
11+ <ul >
12+ <li>Perform any opeartion you would be able to do through the UI</li>
13+ <li>Create complex automations from your local machine</li>
14+ <li>Run complex pipeline use cases by using the CLI inside your pipeline steps</li>
15+ </ul >
Original file line number Diff line number Diff line change 11---
22weight : 40
3- title : API asdsad
3+ title : Pipelines
44---
55
66# Kittens
You can’t perform that action at this time.
0 commit comments