Skip to content

Commit

Permalink
Merge pull request #1232 from run-ai/cli-v2-docs-219
Browse files Browse the repository at this point in the history 
Merge pull request #1231 from run-ai/cli-v2
  • Loading branch information
@yarongol
yarongol authored Nov 12, 2024
2 parents b3a2ca9 + 73d9d26 commit 8d632e4
Show file tree
Hide file tree
Showing 164 changed files with 181 additions and 175 deletions.
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ runai [flags]

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-h, --help help for runai
-q, --quiet enable quiet mode, suppress all output except error messages
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_attach.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ runai attach WORKLOAD_NAME [flags]

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_cluster.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ runai cluster [flags]

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_cluster_list.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ runai cluster list [flags]

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_cluster_set.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ runai cluster set [CLUSTER_NAME] [flags]

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_config.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ runai config [flags]

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_config_generate.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ runai config generate [flags]

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_config_project.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ runai config project PROJECT_NAME [flags]

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_config_set.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ runai config set --status-timeout-duration 300ms

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_describe.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_describe_job.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ runai describe job JOB_NAME [flags]

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_describe_node.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ runai describe node [flags]

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_exec.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ runai exec WORKLOAD_NAME [flags]

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_list.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ runai list [flags]

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_list_clusters.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ runai list clusters [flags]

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_list_jobs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ runai list jobs [flags]

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_list_nodes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ runai list nodes [flags]

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_list_projects.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ runai list projects [flags]

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_login.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ runai login [flags]

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_login_application.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ runai login application [flags]

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_login_sso.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ runai login sso [flags]

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_login_user.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ runai login user -u=user -p=pass

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_logout.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ runai logout [flags]

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_logs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ runai logs WORKLOAD_NAME [flags]

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_mpi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ alias for mpi management

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_mpi_attach.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ runai training mpi attach mpi-01 --pod mpi-01-worker-1 --tty --stdin

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_mpi_bash.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ runai training mpi bash mpi-01 --pod mpi-01-worker-1

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_mpi_delete.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ runai mpi delete [WORKLOAD_NAME] [flags]

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_mpi_describe.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ runai training mpi describe <mpi-name> --containers --pod-limit 20 --event-limit

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_mpi_exec.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ runai training mpi exec mpi-01 --pod mpi-01-worker-1 -- nvidia-smi

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_mpi_list.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ runai training mpi list --limit 20 --offset 40

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_mpi_logs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ runai training mpi logs mpi-01 --wait-timeout=30s

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
2 changes: 1 addition & 1 deletion docs/Researcher/cli-reference/new-cli/runai_mpi_port-forward.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ runai training mpi port-forward mpi-01 --port 8080:8090 --port 6443:443 --addres

```
--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/")
--config-path string config path; can be set by environment variable RUNAI_CLI_CONFIG_PATH
-d, --debug enable debug mode
-q, --quiet enable quiet mode, suppress all output except error messages
--verbose enable verbose mode
Expand Down
Loading

0 comments on commit 8d632e4

Please sign in to comment.