Updates to CLI Reference - RHDEVDOCS-1521

modules/ROOT/nav.adoc

@@ -20,6 +20,16 @@
 ** xref:proc_creating-applications-with-cicd-pipelines.adoc[4.1 Creating-applications with CI/CD pipelines]
 ** xref:proc_interacting-with-pipelines-using-the-developer-perspective.adoc[4.2 Interacting with pipelines using the Developer perspective]
 * xref:assembly_cli-reference.adoc[5. CLI Reference]
-** xref:proc_installing-cli.adoc[5.1 Installing CLI]
-** xref:ref_cli-reference.adoc[5.2 Basic Commands]
+** xref:proc_installing-cli.adoc[5.1 Installing tkn]
+** xref:op-tkn-reference.adoc[5.2 Basic tkn commands]
+*** xref:op-tkn-utility-commands.adoc[5.2.1 Utility commands]
+*** xref:op-tkn-pipeline-management.adoc[5.2.2 Pipeline management commands]
+*** xref:op-tkn-pipeline-run.adoc[5.2.3 Pipelinerun commands]
+*** xref:op-tkn-task-management.adoc[5.2.4 Task management commands]
+*** xref:op-tkn-task-run.adoc[5.2.5 Taskrun commands]
+*** xref:op-tkn-condition-management.adoc[5.2.6 Condition management commands]
+*** xref:op-tkn-pipeline-resource-management.adoc[5.2.7 Pipeline resource management commands]
+*** xref:op-tkn-clustertask-management.adoc[5.2.8 Clustertask management commands]
+*** xref:op-tkn-trigger-management.adoc[5.2.9 Trigger management commands]
+
 * xref:release_notes.adoc[Release Notes]

modules/ROOT/pages/assembly_cli-reference.adoc

@@ -5,15 +5,15 @@
 
 :context: cli-reference
 
-With the Tekton Pipelines command-line interface (CLI) you can interact with Tekton from a terminal. This section describes how to install it and lists the basic commands. 
+With the Tekton (tkn) Pipelines command-line interface (CLI) you can interact with Tekton from a terminal. This section describes how to install it and lists the basic commands.
 
 
 // CLI Installation Guide
 include::proc_installing-cli.adoc[leveloffset=+1]
 
 
 // CLI Reference
-include::ref_cli-reference.adoc[leveloffset=+1]
+include::op-tkn-reference.adoc[leveloffset=+1]
 
 
 

modules/ROOT/pages/op-tkn-clustertask-management.adoc

@@ -0,0 +1,46 @@
+// Module included in the following assemblies:
+//
+// *  pipelines/op-tkn-reference.adoc
+
+[id="op-tkn-clustertask-management-commands_{context}"]
+= Clustertask management commands
+
+== tkn clustertask
+Manage clustertasks.
+
+.Example: Display help
+----
+$ tkn clustertask --help
+----
+
+== tkn clustertask delete
+Delete a clustertask resource in a cluster.
+
+.Example: Delete `mytask1` and `mytask2` clustertasks
+----
+$ tkn clustertask delete mytask1 mytask2
+----
+
+
+== tkn clustertask describe
+Describe a clustertask.
+
+.Example: Describe the `mytask` clustertask
+----
+$ tkn clustertask describe mytask1
+----
+
+== tkn clustertask list
+List clustertasks in a namespace.
+
+.Example: List clustertasks in a namespace
+----
+$ tkn clustertask list -n myspace
+----
+== tkn clustertask start
+Start clustertasks.
+
+.Example: Start the `mytask` clustertask in a namespace
+----
+$ tkn clustertask start mytask -n myspace
+----

modules/ROOT/pages/op-tkn-condition-management.adoc

@@ -0,0 +1,30 @@
+// Module included in the following assemblies:
+//
+// * pipelines/op-tkn-references.adoc
+
+[id="op-tkn-condition-management_{context}"]
+= Condition management commands
+
+== tkn condition
+Manage conditions.
+
+.Example: Display help
+----
+$ tkn condition --help
+----
+
+== tkn condition delete
+Delete a condition in a namespace.
+
+.Example: Delete the `mycondition1` condition from a namespace
+----
+$ tkn condition delete mycondition1 -n myspace
+----
+
+== tkn condition list
+List conditions in a namespace.
+
+.Example: List conditions in a namespace
+----
+$ tkn condition list -n myspace
+----

modules/ROOT/pages/op-tkn-pipeline-management.adoc

@@ -0,0 +1,63 @@
+// Module included in the following assemblies:
+//
+// * pipelines/op-tkn-references.adoc
+
+[id="op-tkn-pipeline-management_{context}"]
+= Pipelines management commands
+
+== tkn pipeline
+Manage pipelines.
+
+.Example: Display help
+----
+$ pipeline --help
+----
+
+== tkn pipeline create
+Create a pipeline in a namespace.
+
+.Example: Create a pipeline defined by the `mypipeline.yaml` file in a namespace
+-----
+$ tkn pipeline create -f mypipeline.yaml -n myspace
+-----
+
+== tkn pipeline delete
+
+Delete a pipeline in a namespace.
+
+.Example: Delete the `mypipeline` pipeline from a namespace
+----
+$ tkn pipeline delete mypipeline -n myspace
+----
+
+== tkn pipeline describe
+Describe a pipeline in a namespace.
+
+.Example: Describe `mypipeline` pipeline
+----
+$ tkn pipeline describe mypipeline
+----
+
+== tkn pipeline list
+List pipelines in a namespace.
+
+.Example: Display a list of pipelines
+-----
+$ tkn pipeline list
+-----
+
+== tkn pipeline logs
+Display pipeline logs for a specific pipeline.
+
+.Example: Stream live logs for the `mypipeline` pipeline
+----
+$ tkn pipeline logs -f mypipeline
+----
+
+== tkn pipeline start
+Start a pipeline.
+
+.Example: Start `mypipeline` pipeline
+----
+$ tkn pipeline start mypipeline
+----

modules/ROOT/pages/op-tkn-pipeline-resource-management.adoc

@@ -0,0 +1,45 @@
+// Module included in the following assemblies:
+//
+// *  pipelines/op-tkn-reference.adoc
+
+[id="op-tkn-pipeline-resource-management_{context}"]
+= Pipeline resource management commands
+
+== tkn resource
+Manage pipeline resources.
+
+.Example: Display help
+----
+$ tkn resource -h
+----
+
+== tkn resource create
+Create a pipeline resource in a namespace.
+
+.Example: Create pipeline resource defined by the `myresource.yaml` file in a namespace
+----
+$ tkn resource create -f myresource.yaml -n myspace
+----
+
+== tkn resource delete
+Delete a pipeline resource in a namespace.
+
+.Example: Delete the `myresource` pipeline resource from a namespace
+----
+$ tkn resource delete myresource -n myspace
+----
+
+== tkn resource describe
+Describes a pipeline resource in a namespace.
+
+.Example: Describe the `myresource` pipeline resource
+----
+$ tkn resource describe myresource -n `myspace`
+----
+== tkn resource list
+List pipeline resources in a namespace.
+
+.Example: List all pipeline resources in a namespace
+----
+$ tkn resource list -n `myspace`
+----

modules/ROOT/pages/op-tkn-pipeline-run.adoc

@@ -0,0 +1,55 @@
+// Module included in the following assemblies:
+//
+// * pipelines/op-tkn-references.adoc
+
+[id="op-tkn-pipeline-run_{context}"]
+= Pipelinerun commands
+
+
+== tkn pipelinerun
+Manage pipelineruns.
+
+.Example: Display help
+----
+$ tkn pipelinerun -h
+----
+
+== tkn pipelinerun cancel
+Cancel a pipelinerun in a namespace.
+
+.Example: Cancel the `mypipelinerun` pipelinerun from a namespace
+----
+$ tkn pipeline cancel mypipelinerun -n myspace
+----
+
+== tkn pipelinerun delete
+Delete pipelinerun in a namespace.
+
+.Example: Delete pipelineruns from a namespace
+----
+$ tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace
+----
+
+== tkn pipelinerun describe
+Describe a pipelinerun in a namespace.
+
+.Example: Describe the `mypipelinerun` pipelinerun in a namespace
+----
+tkn pipelinerun describe mypipelinerun -n myspace
+----
+
+== tkn pipelinerun list
+Display a list of pipelineruns in a namespace.
+
+.Example: Display a list of pipelineruns in a namespace
+----
+$ tkn pipelinerun list -n myspace
+----
+
+== tkn pipelinerun logs
+Show the logs of pipelinerun.
+
+.Example: Display the logs of the `mypipelinerun` pipelinerun with all tasks and steps in a namespace
+----
+$ tkn pipelinerun logs mypipeline -a -n myspace
+----

modules/ROOT/pages/op-tkn-reference.adoc

@@ -0,0 +1,24 @@
+[id='op-tkn-reference']
+= Pipeline `tkn` reference
+//include::modules/common-attributes.adoc[]
+:context: op-tkn-reference
+toc::[]
+
+
+This section lists basic `tkn` CLI commands. For a more detailed description, see link:https://github.com/tektoncd/cli[Tekton Pipelines CLI].
+
+== Basic Syntax
+`tkn [command or options] [arguments...]`
+
+== Global Options
+`--help, -h`
+
+include::op-tkn-utility-commands.adoc[leveloffset=+1]
+include::op-tkn-pipeline-management.adoc[leveloffset=+1]
+include::op-tkn-pipeline-run.adoc[leveloffset=+1]
+include::op-tkn-task-management.adoc[leveloffset=+1]
+include::op-tkn-task-run.adoc[leveloffset=+1]
+include::op-tkn-condition-management.adoc[leveloffset=+1]
+include::op-tkn-pipeline-resource-management.adoc[leveloffset=+1]
+include::op-tkn-clustertask-management.adoc[leveloffset=+1]
+include::op-tkn-trigger-management.adoc[leveloffset=+1]

modules/ROOT/pages/op-tkn-task-management.adoc

@@ -0,0 +1,62 @@
+// Module included in the following assemblies:
+//
+// *  pipelines/op-tkn-reference.adoc
+
+[id="op-tkn-task-management_{context}"]
+= Task management commands
+
+== tkn task
+Manage tasks.
+
+.Example: Display help
+----
+$ tkn task -h
+----
+
+== tkn task create
+Create a task in a namespace.
+
+.Example: Create a task defined by the `mytask.yaml` file in a namespace
+----
+$ tkn task create -f mytask.yaml -n myspace
+----
+
+== tkn task delete
+Delete task resources in a namespace.
+
+.Example: Delete `mytask1` and `mytask2` tasks from a namespace
+----
+$ tkn task delete mytask1 mytask2 -n myspace
+----
+
+== tkn task describe
+Describe a task in a namespace.
+
+.Example: Describe the `mytask` task in a namespace
+----
+$ tkn task describe mytask -n myspace
+----
+
+== tkn task list
+List tasks in a namespace.
+
+.Example: List all the tasks in a namespace
+----
+$ tkn task list -n myspace
+----
+
+== tkn task logs
+Display task logs.
+
+.Example: Display logs for the `mytaskrun` taskrun of the `mytask` task
+----
+$ tkn task logs mytask mytaskrun -n myspace
+----
+
+== tkn task start
+Start a task.
+
+.Example: Start the `mytask` task in a namespace
+----
+$ tkn task start mytask -s <ServiceAccountName> -n myspace
+----