Merge pull request #823 from run-ai:v2.18-RUN-16337-CLI-V2

V2.18-RUN-16337-CLI-V2

Author: jasonnovichRunAI

docs/Researcher/cli-reference/new-cli/runai.md

@@ -0,0 +1,42 @@
+---
+title: Run:ai Command-line Interface
+summary: This article is the summary article for the CLI V2.
+authors:
+    -  Jason Novich 
+date: 2024-Jun-18
+---
+
+## Summary
+
+The Run:ai Command-line Interface (CLI) tool for a Researcher to send deep learning workloads, acquire GPU-based containers, list jobs, and access other features in the Run:ai platform.
+
+```
+runai [flags]
+```
+
+### Options
+
+```
+      --config-file string   config file name; can be set by environment variable RUNAI_CLI_CONFIG_FILE (default "config.json")
+      --config-path string   config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH (default "~/.runai/")
+  -d, --debug                enable debug mode
+  -h, --help                 help for runai
+  -v, --verbose              enable verbose mode
+```
+
+### See Also
+
+* [runai cluster](runai_cluster.md)—cluster management
+* [runai config](runai_config.md)—configuration management
+* [runai list](runai_list.md)—[Deprecated] display resource list. By default displays the job list
+* [runai login](runai_login.md)—login to the control plane
+* [runai logout](runai_logout.md)—logout from control plane
+* [runai node](runai_node.md)—node management
+* [runai nodepool](runai_nodepool.md)—node pool management
+* [runai project](runai_project.md)—project management
+* [runai report](runai_report.md)—report management
+* [runai training](runai_training.md)—training management
+* [runai upgrade](runai_upgrade.md)—upgrades the CLI to the latest version
+* [runai version](runai_version.md)—print version information
+* [runai workload](runai_workload.md)—workload management
+* [runai workspace](runai_workspace.md)—workspace management

docs/Researcher/cli-reference/new-cli/runai_cluster.md

@@ -0,0 +1,30 @@
+## runai cluster
+
+cluster management
+
+```
+runai cluster [flags]
+```
+
+### Options
+
+```
+  -h, --help                 help for cluster
+      --interactive enable   set interactive mode (enabled|disabled)
+```
+
+### Options inherited from parent commands
+
+```
+      --config-file string   config file name; can be set by environment variable RUNAI_CLI_CONFIG_FILE (default "config.json")
+      --config-path string   config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH (default "~/.runai/")
+  -d, --debug                enable debug mode
+  -v, --verbose              enable verbose mode
+```
+
+### SEE ALSO
+
+* [runai](runai.md)	 - Run:ai Command-line Interface
+* [runai cluster list](runai_cluster_list.md)	 - cluster list command
+* [runai cluster set](runai_cluster_set.md)	 - set cluster context
+

docs/Researcher/cli-reference/new-cli/runai_cluster_list.md

@@ -0,0 +1,30 @@
+## runai cluster list
+
+cluster list command
+
+```
+runai cluster list [flags]
+```
+
+### Options
+
+```
+  -h, --help    help for list
+      --json    Output structure JSON
+      --table   Output structure table
+      --yaml    Output structure YAML
+```
+
+### Options inherited from parent commands
+
+```
+      --config-file string   config file name; can be set by environment variable RUNAI_CLI_CONFIG_FILE (default "config.json")
+      --config-path string   config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH (default "~/.runai/")
+  -d, --debug                enable debug mode
+  -v, --verbose              enable verbose mode
+```
+
+### SEE ALSO
+
+* [runai cluster](runai_cluster.md)	 - cluster management
+

docs/Researcher/cli-reference/new-cli/runai_cluster_set.md

@@ -0,0 +1,29 @@
+## runai cluster set
+
+set cluster context
+
+```
+runai cluster set [flags]
+```
+
+### Options
+
+```
+  -h, --help          help for set
+      --id string     set by cluster ID
+      --name string   set by cluster name
+```
+
+### Options inherited from parent commands
+
+```
+      --config-file string   config file name; can be set by environment variable RUNAI_CLI_CONFIG_FILE (default "config.json")
+      --config-path string   config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH (default "~/.runai/")
+  -d, --debug                enable debug mode
+  -v, --verbose              enable verbose mode
+```
+
+### SEE ALSO
+
+* [runai cluster](runai_cluster.md)	 - cluster management
+

docs/Researcher/cli-reference/new-cli/runai_config.md

@@ -0,0 +1,30 @@
+## runai config
+
+configuration management
+
+```
+runai config [flags]
+```
+
+### Options
+
+```
+  -h, --help                 help for config
+      --interactive enable   set interactive mode (enabled|disabled)
+```
+
+### Options inherited from parent commands
+
+```
+      --config-file string   config file name; can be set by environment variable RUNAI_CLI_CONFIG_FILE (default "config.json")
+      --config-path string   config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH (default "~/.runai/")
+  -d, --debug                enable debug mode
+  -v, --verbose              enable verbose mode
+```
+
+### SEE ALSO
+
+* [runai](runai.md)	 - Run:ai Command-line Interface
+* [runai config generate](runai_config_generate.md)	 - generate config file
+* [runai config set](runai_config_set.md)	 - Set configuration values
+

docs/Researcher/cli-reference/new-cli/runai_config_generate.md

@@ -0,0 +1,30 @@
+## runai config generate
+
+generate config file
+
+```
+runai config generate [flags]
+```
+
+### Options
+
+```
+      --file string   Output structure to file
+  -h, --help          help for generate
+      --json          Output structure JSON
+      --yaml          Output structure YAML
+```
+
+### Options inherited from parent commands
+
+```
+      --config-file string   config file name; can be set by environment variable RUNAI_CLI_CONFIG_FILE (default "config.json")
+      --config-path string   config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH (default "~/.runai/")
+  -d, --debug                enable debug mode
+  -v, --verbose              enable verbose mode
+```
+
+### SEE ALSO
+
+* [runai config](runai_config.md)	 - configuration management
+

docs/Researcher/cli-reference/new-cli/runai_config_set.md

@@ -0,0 +1,31 @@
+## runai config set
+
+Set configuration values
+
+```
+runai config set [flags]
+```
+
+### Options
+
+```
+      --auth-url string      set the authorization URL
+      --cp-url string        set the control plane URL
+  -h, --help                 help for set
+      --interactive enable   set interactive mode (enabled|disabled)
+      --output string        set the default output type
+```
+
+### Options inherited from parent commands
+
+```
+      --config-file string   config file name; can be set by environment variable RUNAI_CLI_CONFIG_FILE (default "config.json")
+      --config-path string   config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH (default "~/.runai/")
+  -d, --debug                enable debug mode
+  -v, --verbose              enable verbose mode
+```
+
+### SEE ALSO
+
+* [runai config](runai_config.md)	 - configuration management
+

docs/Researcher/cli-reference/new-cli/runai_list.md

@@ -0,0 +1,33 @@
+## runai list
+
+[Deprecated] display resource list. By default displays the job list
+
+```
+runai list [flags]
+```
+
+### Options
+
+```
+  -A, --all-projects     list jobs from all projects
+  -h, --help             help for list
+  -p, --project string   Specify the project to which the command applies. By default, commands apply to the default project. To change the default project use ‘runai config project <project name>’
+```
+
+### Options inherited from parent commands
+
+```
+      --config-file string   config file name; can be set by environment variable RUNAI_CLI_CONFIG_FILE (default "config.json")
+      --config-path string   config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH (default "~/.runai/")
+  -d, --debug                enable debug mode
+  -v, --verbose              enable verbose mode
+```
+
+### SEE ALSO
+
+* [runai](runai.md)	 - Run:ai Command-line Interface
+* [runai list clusters](runai_list_clusters.md)	 - [Deprecated] list all available clusters
+* [runai list jobs](runai_list_jobs.md)	 - [Deprecated] list all jobs
+* [runai list nodes](runai_list_nodes.md)	 - [Deprecated] list all nodes
+* [runai list projects](runai_list_projects.md)	 - [Deprecated] list all available projects
+

docs/Researcher/cli-reference/new-cli/runai_list_clusters.md

@@ -0,0 +1,30 @@
+## runai list clusters
+
+[Deprecated] list all available clusters
+
+```
+runai list clusters [flags]
+```
+
+### Options
+
+```
+  -h, --help    help for clusters
+      --json    Output structure JSON
+      --table   Output structure table
+      --yaml    Output structure YAML
+```
+
+### Options inherited from parent commands
+
+```
+      --config-file string   config file name; can be set by environment variable RUNAI_CLI_CONFIG_FILE (default "config.json")
+      --config-path string   config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH (default "~/.runai/")
+  -d, --debug                enable debug mode
+  -v, --verbose              enable verbose mode
+```
+
+### SEE ALSO
+
+* [runai list](runai_list.md)	 - [Deprecated] display resource list. By default displays the job list
+

docs/Researcher/cli-reference/new-cli/runai_list_jobs.md

@@ -0,0 +1,32 @@
+## runai list jobs
+
+[Deprecated] list all jobs
+
+```
+runai list jobs [flags]
+```
+
+### Options
+
+```
+  -A, --all-projects     list jobs from all projects
+  -h, --help             help for jobs
+      --json             Output structure JSON
+  -p, --project string   Specify the project to which the command applies. By default, commands apply to the default project. To change the default project use ‘runai config project <project name>’
+      --table            Output structure table
+      --yaml             Output structure YAML
+```
+
+### Options inherited from parent commands
+
+```
+      --config-file string   config file name; can be set by environment variable RUNAI_CLI_CONFIG_FILE (default "config.json")
+      --config-path string   config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH (default "~/.runai/")
+  -d, --debug                enable debug mode
+  -v, --verbose              enable verbose mode
+```
+
+### SEE ALSO
+
+* [runai list](runai_list.md)	 - [Deprecated] display resource list. By default displays the job list
+