From 69a47f380fe44666bd6a2e26372eae20de8868d7 Mon Sep 17 00:00:00 2001
From: Itai Gendler Welcome to Codefresh’s official CLI documentation! Codefresh CLI provides a full and flexible interface to interact with Codefresh.
-Generate a new API key through the account settings page.
-Once you have the API key, create a new authentication context: `codefresh auth create-context --api-key {API_KEY}`
+Generate a new API key through the account settings page.
+
+Once you have the API key, create a new authentication context:
`codefresh auth create-context --api-key {API_KEY}`
## Advanced Usage
diff --git a/docs-template/content/pipelines.md b/docs-template/content/pipelines.md
index 449bc1e47..3ff74f486 100644
--- a/docs-template/content/pipelines.md
+++ b/docs-template/content/pipelines.md
@@ -3,56 +3,112 @@ weight: 40
title: Pipelines
---
-# Kittens
+# Pipelines
-## Get All Kittens
+## Get All Pipelines
```cli
-package main
+$ codefresh get pipelines
+```
-import "github.com/bep/kittn/auth"
+```string
+ID NAME REPOOWNER REPONAME
+55fa65a21058fb6778dc5eef codefresh-io codefresh-io codefresh-io
+55fa65a21058fb6778dc5f19 repo-analyser verchol repo-analyser
+55fa65a21058fb6778dc5f4f engine codefresh-io engine
+55fa65a21058fb6778dc5f55 git-clone codefresh-io cf-base-images
+```
-func main() {
- api := auth.Authorize("meowmeowmeow")
+```cli
+$ codefresh get pipelines --name engine
+```
- _ = api.GetKittens()
-}
+```string
+ID NAME REPOOWNER REPONAME
+55fa65a21058fb6778dc5f4f engine codefresh-io engine
```
-> The above command returns JSON structured like this:
+```cli
+$ codefresh get pipelines --repo-name repo-analyser
+```
-```json
-[
- {
- "id": 1,
- "name": "Fluffums",
- "breed": "calico",
- "fluffiness": 6,
- "cuteness": 7
- },
- {
- "id": 2,
- "name": "Max",
- "breed": "unknown",
- "fluffiness": 5,
- "cuteness": 10
- }
-]
+```string
+ID NAME REPOOWNER REPONAME
+55fa65a21058fb6778dc5f19 repo-analyser verchol repo-analyser
```
-This endpoint retrieves all kittens.
+```cli
+$ codefresh get pipelines --repo-owner codefresh-io
+```
+
+```string
+ID NAME REPOOWNER REPONAME
+55fa65a21058fb6778dc5eef codefresh-io codefresh-io codefresh-io
+55fa65a21058fb6778dc5f4f engine codefresh-io engine
+55fa65a21058fb6778dc5f55 git-clone codefresh-io cf-base-images
+```
+
+This command will retrieve an array of pipelines according to the passed filters.
+
+### Command
+
+`codefresh get pipelines`
+
+### Aliases
+
+
+
+
+### Filter Options
+
+Option | Default | Description
+--------- | ----------- | -----------
+--repo-owner | | Filter pipelines by repository owner.
+--repo-name | | Filter pipelines by repository name.
+--name | | Filter pipelines by pipeline name.
+
+### Output Options
+
+Option | Default | Description
+--------- | ----------- | -----------
+--output | | Output format [choices: "json", "yaml", "wide", "name"].
+--watch | false | If set to true, the output will continue to get updated.
+--watch-interval | 3 | Interval time to get updates from the server.
+--limit | 25 | Limit amount of returned results.
+--page | 1 | Get a specific set of results according to the defined limit option.
+
+
+## Get a Single Pipeline
+
+```cli
+$ codefresh get pipeline 55fa65a21058fb6778dc5eef
+```
+
+> The above command returns a structured table like this:
+
+```string
+ID NAME REPOOWNER REPONAME
+55fa65a21058fb6778dc5eef codefresh-io codefresh-io codefresh-io
+```
+
+This command will retrieve a single pipeline.
+
+### Command
-### HTTP Request
+`codefresh get pipeline {ID}`
-`GET http://example.com/api/kittens`
+### Positionals arguments
-### Query Parameters
+Argument | Description
+--------- | -----------
+id | Pipeline id.
-Parameter | Default | Description
---------- | ------- | -----------
-include_cats | false | If set to true, the result will also include cats.
-available | true | If set to false, the result will include kittens that have already been adopted.
+### Output Options
-
+Option | Default | Description
+--------- | ----------- | -----------
+--output | | Output format [choices: "json", "yaml", "wide", "name"].
+--watch | false | If set to true, the output will continue to get updated.
+--watch-interval | 3 | Interval time to get updates from the server.
diff --git a/docs/index.html b/docs/index.html
index 3ec457ec1..4e1ee470c 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -51,6 +51,21 @@
+Introduction
+
+
+The CLI can be used to achieve the following:
+
+
Codefresh CLI is developed and built with node.js. @@ -116,60 +131,159 @@
Welcome to Codefresh’s official CLI documentation!
+In order to start working with the cli you will need to update the authentication configuration.
+Generate a new API key through the account settings page.
Once you have the API key, create a new authentication context:
codefresh auth create-context --api-key {API_KEY}
$ codefresh get pipelines
ID NAME REPOOWNER REPONAME
+55fa65a21058fb6778dc5eef codefresh-io codefresh-io codefresh-io
+55fa65a21058fb6778dc5f19 repo-analyser verchol repo-analyser
+55fa65a21058fb6778dc5f4f engine codefresh-io engine
+55fa65a21058fb6778dc5f55 git-clone codefresh-io cf-base-images
$ codefresh get pipelines --name engine
ID NAME REPOOWNER REPONAME
+55fa65a21058fb6778dc5f4f engine codefresh-io engine
$ codefresh get pipelines --repo-name repo-analyser
ID NAME REPOOWNER REPONAME
+55fa65a21058fb6778dc5f19 repo-analyser verchol repo-analyser
$ codefresh get pipelines --repo-owner codefresh-io
ID NAME REPOOWNER REPONAME
+55fa65a21058fb6778dc5eef codefresh-io codefresh-io codefresh-io
+55fa65a21058fb6778dc5f4f engine codefresh-io engine
+55fa65a21058fb6778dc5f55 git-clone codefresh-io cf-base-images
This command will retrieve an array of pipelines according to the passed filters.
+ +codefresh get pipelines
Option | +Default | +Description | +
---|---|---|
–repo-owner | ++ | Filter pipelines by repository owner. | +
–repo-name | ++ | Filter pipelines by repository name. | +
–name | ++ | Filter pipelines by pipeline name. | +
Option | +Default | +Description | +
---|---|---|
–output | ++ | Output format [choices: “json”, “yaml”, “wide”, “name”]. | +
–watch | +false | +If set to true, the output will continue to get updated. | +
–watch-interval | +3 | +Interval time to get updates from the server. | +
–limit | +25 | +Limit amount of returned results. | +
–page | +1 | +Get a specific set of results according to the defined limit option. | +
$ codefresh get pipeline 55fa65a21058fb6778dc5eef
--The above command returns JSON structured like this:
+The above command returns a structured table like this:
[
- {
- "id": 1,
- "name": "Fluffums",
- "breed": "calico",
- "fluffiness": 6,
- "cuteness": 7
- },
- {
- "id": 2,
- "name": "Max",
- "breed": "unknown",
- "fluffiness": 5,
- "cuteness": 10
- }
-]
This endpoint retrieves all kittens.
- -GET http://example.com/api/kittens
ID NAME REPOOWNER REPONAME
+55fa65a21058fb6778dc5eef codefresh-io codefresh-io codefresh-io
This command will retrieve a single pipeline.
+ +codefresh get pipeline {ID}
Parameter | +Argument | +Description | +
---|---|---|
id | +Pipeline id. | +
Option | Default | Description | |||
---|---|---|---|---|---|
include_cats | +–output | ++ | Output format [choices: “json”, “yaml”, “wide”, “name”]. | +||
–watch | false | -If set to true, the result will also include cats. | +If set to true, the output will continue to get updated. | ||
available | -true | -If set to false, the result will include kittens that have already been adopted. | +–watch-interval | +3 | +Interval time to get updates from the server. |