Skip to content

Commit ba7852d

Browse files
Itai GendlerItai Gendler
Itai Gendler
authored and
Itai Gendler
committed
Update instalation instructions
1 parent 33364bb commit ba7852d

File tree

8 files changed

+187
-46
lines changed

8 files changed

+187
-46
lines changed

‎docs-template/content/Installation.md‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
weight: 10
3+
title: API Reference
4+
---
5+
6+
# Installation
7+
Codefresh CLI is developed and built with node.js.
8+
In case you have node.js installed on your machine you can use npm or yarn to install it.<br>
9+
If you don't have node.js installed you can install the CLI by downloading a binary.
10+
11+
## NPM
12+
Codefresh's cli is available for installation through NPM registry.
13+
14+
Install:
15+
`npm install -g codefresh`
16+
17+
Install a specific version:
18+
`npm install -g codefresh@{VERSION}`
19+
20+
Update to latest version:
21+
`npm install -g codefresh`
22+
23+
Update to a specific version:
24+
`npm install -g codefresh@${VERSION}`
25+
26+
## YARN
27+
Install:
28+
`yarn global add codefresh`
29+
30+
Install a specific version:
31+
`yarn global add codefresh@{VERSION}`
32+
33+
Update to latest version:
34+
`yarn global upgrade codefresh`
35+
36+
Update to a specific version:
37+
`yarn global upgrade codefresh@{VERSION}`
38+
39+
## Binaries
40+
Navigate to <a href="https://github.com/codefresh-io/cli/releases" target="_blank">Official Releases</a>
41+
and download the binary that matches your operating system.<br>
42+
We currently support the following OS: <br>
43+
<ul>
44+
<li><a href="https://github.com/codefresh-io/cli/releases/download/v0.6.6/codefresh-v0.6.6-linux-x64.tar.gz" target="_blank">Linux-x64</a></li>
45+
<li><a href="https://github.com/codefresh-io/cli/releases/download/v0.6.6/codefresh-v0.6.6-macos-x64.tar.gz" target="_blank">Macos-x64</a></li>
46+
<li><a href="https://github.com/codefresh-io/cli/releases/download/v0.6.6/codefresh-v0.6.6-win-x64.tar.gz" target="_blank">Windows-x64</a></li>
47+
</ul>
48+
49+
After downloading the binary, untar or unzip it and your are good to go.<br>
50+
You can also add the binary to your system PATH environment variable so you can use it easily.
51+
52+
If your operating system is missing please feel free to open us an issue in our <a href="https://github.com/codefresh-io/cli/issues" target="_blank">Github repository</a>.
53+
54+
## Docker image
55+
You can run the CLI using our official docker image which is published to <a href="https://hub.docker.com/r/codefresh/cli/" target="_blank">Dockerhub</a><br>
56+
57+
Pull the latest version:
58+
`docker pull codefresh/cli`
59+
60+
Pull a specific version:
61+
`docker pull codefresh/cli:${VERSION}`
62+

‎docs-template/content/errors.md‎

Lines changed: 0 additions & 26 deletions
This file was deleted.

‎docs-template/content/introduction.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
weight: 10
3+
title: API Reference
4+
---
5+
6+
# Introduction
7+
8+
Welcome to Codefresh's official CLI documentation!
9+
10+
## Installation
11+
12+
### From Binaries

‎docs-template/content/index.md‎ renamed to ‎docs-template/content/pipelines.md‎

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,8 @@
11
---
2-
weight: 10
3-
title: API Reference
2+
weight: 40
3+
title: API asdsad
44
---
55

6-
# Introduction
7-
8-
Welcome to the Kittn API! You can use our API to access Kittn API endpoints, which can get information on various cats, kittens, and breeds in our database.
9-
10-
We have language bindings in Shell, Ruby, and Python! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.
11-
12-
**This example API documentation page was created with [DocuAPI](https://github.com/bep/docuapi/), a multilingual documentation theme for the static site generator [Hugo](http://gohugo.io/).**
13-
146
# Kittens
157

168
## Get All Kittens

‎docs/index.html‎

Lines changed: 71 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,81 @@
5151

5252

5353

54+
<h1 id="installation">Installation</h1>
55+
56+
<p>Codefresh CLI is developed and built with node.js.
57+
In case you have node.js installed on your machine you can use npm or yarn to install it.<br>
58+
If you don&rsquo;t have node.js installed you can install the CLI by downloading a binary.</p>
59+
60+
<h2 id="npm">NPM</h2>
61+
62+
<p>Codefresh&rsquo;s cli is available for installation through NPM registry.</p>
63+
64+
<p>Install:
65+
<code>npm install -g codefresh</code></p>
66+
67+
<p>Install a specific version:
68+
<code>npm install -g codefresh@{VERSION}</code></p>
69+
70+
<p>Update to latest version:
71+
<code>npm install -g codefresh</code></p>
72+
73+
<p>Update to a specific version:
74+
<code>npm install -g codefresh@${VERSION}</code></p>
75+
76+
<h2 id="yarn">YARN</h2>
77+
78+
<p>Install:
79+
<code>yarn global add codefresh</code></p>
80+
81+
<p>Install a specific version:
82+
<code>yarn global add codefresh@{VERSION}</code></p>
83+
84+
<p>Update to latest version:
85+
<code>yarn global upgrade codefresh</code></p>
86+
87+
<p>Update to a specific version:
88+
<code>yarn global upgrade codefresh@{VERSION}</code></p>
89+
90+
<h2 id="binaries">Binaries</h2>
91+
92+
<p>Navigate to <a href="https://github.com/codefresh-io/cli/releases" target="_blank">Official Releases</a>
93+
and download the binary that matches your operating system.<br>
94+
We currently support the following OS: <br>
95+
<ul>
96+
<li><a href="https://github.com/codefresh-io/cli/releases/download/v0.6.6/codefresh-v0.6.6-linux-x64.tar.gz" target="_blank">Linux-x64</a></li>
97+
<li><a href="https://github.com/codefresh-io/cli/releases/download/v0.6.6/codefresh-v0.6.6-macos-x64.tar.gz" target="_blank">Macos-x64</a></li>
98+
<li><a href="https://github.com/codefresh-io/cli/releases/download/v0.6.6/codefresh-v0.6.6-win-x64.tar.gz" target="_blank">Windows-x64</a></li>
99+
</ul></p>
100+
101+
<p>After downloading the binary, untar or unzip it and your are good to go.<br>
102+
You can also add the binary to your system PATH environment variable so you can use it easily.</p>
103+
104+
<p>If your operating system is missing please feel free to open us an issue in our <a href="https://github.com/codefresh-io/cli/issues" target="_blank">Github repository</a>.</p>
105+
106+
<h2 id="docker-image">Docker image</h2>
107+
108+
<p>You can run the CLI using our official docker image which is published to <a href="https://hub.docker.com/r/codefresh/cli/" target="_blank">Dockerhub</a><br></p>
109+
110+
<p>Pull the latest version:
111+
<code>docker pull codefresh/cli</code></p>
112+
113+
<p>Pull a specific version:
114+
<code>docker pull codefresh/cli:${VERSION}</code></p>
115+
116+
117+
118+
54119
<h1 id="introduction">Introduction</h1>
55120

56-
<p>Welcome to the Kittn API! You can use our API to access Kittn API endpoints, which can get information on various cats, kittens, and breeds in our database.</p>
121+
<p>Welcome to Codefresh&rsquo;s official CLI documentation!</p>
57122

58-
<p>We have language bindings in Shell, Ruby, and Python! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.</p>
123+
<h2 id="installation">Installation</h2>
59124

60-
<p><strong>This example API documentation page was created with <a href="https://github.com/bep/docuapi/">DocuAPI</a>, a multilingual documentation theme for the static site generator <a href="http://gohugo.io/">Hugo</a>.</strong></p>
125+
<h3 id="from-binaries">From Binaries</h3>
126+
127+
128+
61129

62130
<h1 id="kittens">Kittens</h1>
63131

‎docs/index.xml‎

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,38 @@
1212

1313
<item>
1414
<title>API Reference</title>
15-
<link>http://cli.codefresh.io/</link>
15+
<link>http://cli.codefresh.io/installation/</link>
1616
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
1717

18-
<guid>http://cli.codefresh.io/</guid>
19-
<description>Introduction Welcome to the Kittn API! You can use our API to access Kittn API endpoints, which can get information on various cats, kittens, and breeds in our database.
20-
We have language bindings in Shell, Ruby, and Python! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.
21-
This example API documentation page was created with DocuAPI, a multilingual documentation theme for the static site generator Hugo.</description>
18+
<guid>http://cli.codefresh.io/installation/</guid>
19+
<description>Installation Codefresh CLI is developed and built with node.js. In case you have node.js installed on your machine you can use npm or yarn to install it.
20+
If you don&amp;rsquo;t have node.js installed you can install the CLI by downloading a binary.
21+
NPM Codefresh&amp;rsquo;s cli is available for installation through NPM registry.
22+
Install: npm install -g codefresh
23+
Install a specific version: npm install -g codefresh@{VERSION}
24+
Update to latest version: npm install -g codefresh</description>
25+
</item>
26+
27+
<item>
28+
<title>API Reference</title>
29+
<link>http://cli.codefresh.io/introduction/</link>
30+
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
31+
32+
<guid>http://cli.codefresh.io/introduction/</guid>
33+
<description> Introduction Welcome to Codefresh&amp;rsquo;s official CLI documentation!
34+
Installation From Binaries </description>
35+
</item>
36+
37+
<item>
38+
<title>API asdsad</title>
39+
<link>http://cli.codefresh.io/pipelines/</link>
40+
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
41+
42+
<guid>http://cli.codefresh.io/pipelines/</guid>
43+
<description>Kittens Get All Kittens package main import &amp;#34;github.com/bep/kittn/auth&amp;#34; func main() { api := auth.Authorize(&amp;#34;meowmeowmeow&amp;#34;) _ = api.GetKittens() } The above command returns JSON structured like this:
44+
[ { &amp;#34;id&amp;#34;: 1, &amp;#34;name&amp;#34;: &amp;#34;Fluffums&amp;#34;, &amp;#34;breed&amp;#34;: &amp;#34;calico&amp;#34;, &amp;#34;fluffiness&amp;#34;: 6, &amp;#34;cuteness&amp;#34;: 7 }, { &amp;#34;id&amp;#34;: 2, &amp;#34;name&amp;#34;: &amp;#34;Max&amp;#34;, &amp;#34;breed&amp;#34;: &amp;#34;unknown&amp;#34;, &amp;#34;fluffiness&amp;#34;: 5, &amp;#34;cuteness&amp;#34;: 10 } ] This endpoint retrieves all kittens.
45+
HTTP Request GET http://example.com/api/kittens
46+
Query Parameters Parameter Default Description include_cats false If set to true, the result will also include cats.</description>
2247
</item>
2348

2449
</channel>

‎docs/sitemap.xml‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,15 @@
33
xmlns:xhtml="http://www.w3.org/1999/xhtml">
44

55
<url>
6-
<loc>http://cli.codefresh.io/</loc>
6+
<loc>http://cli.codefresh.io/installation/</loc>
7+
</url>
8+
9+
<url>
10+
<loc>http://cli.codefresh.io/introduction/</loc>
11+
</url>
12+
13+
<url>
14+
<loc>http://cli.codefresh.io/pipelines/</loc>
715
</url>
816

917
<url>

‎lib/interface/cli/codefresh‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ recursive(path.resolve(__dirname, 'commands'), (err, files) => {
6868
\\____|\\___/ \\__,_|\\___|_| _| \\___|____/_| |_| \\____|_____|___|
6969
7070
71-
For more information, find our official documentation at https://github.com/codefresh-io/cli
71+
For more information, find our official documentation at http://cli.codefresh.io
7272
`)
7373
// .option('help', {
7474
// global: false,

0 commit comments

Comments
 (0)