CR-20734-update documentation for pipeline label filter. (#850)

codefresh-io · Nov 7, 2023 · 88bc9b9 · 88bc9b9
1 parent 010087f
commit 88bc9b9
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/lib/interface/cli/commands/pipeline/get.cmd.js b/lib/interface/cli/commands/pipeline/get.cmd.js
@@ -52,9 +52,8 @@ const command = new Command({
                 describe: 'Filter pipelines by project name',
             })
             .option('label', {
-                describe: 'Filter by a label',
+                describe: 'Filter by a label - i.e tags=tag1,tag2',
                 alias: 'l',
-                default: [],
             })
             .option('limit', {
                 describe: `Limit amount of returned results [default: ${DEFAULTS.GET_LIMIT_RESULTS}]`,
@@ -65,7 +64,9 @@ const command = new Command({
             .option('page', {
                 describe: 'Paginated page',
                 default: DEFAULTS.GET_PAGINATED_PAGE,
-            });
+            })
+            .example('codefresh get pipeline --name PIPELINE_NAME', 'Get specific pipeline by it name')
+            .example('codefresh get pip --label tags=tag1,tag2', 'Get list of pipelines by tag name');
     },
     handler: async (argv) => {
         const { id: ids, name, d: decryptVariables, projectId, project: projectName, all } = argv;

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "codefresh",
-  "version": "0.87.1",
+  "version": "0.87.2",
   "description": "Codefresh command line utility",
   "main": "index.js",
   "preferGlobal": true,