Skip to content

Commit 613b809

Browse files
committed
feat: more cli docs
1 parent 42d8706 commit 613b809

3 files changed

Lines changed: 22 additions & 1 deletion

File tree

.github/tape_collection/cli_config.tape

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Output docs/cli/demos/config.gif
22

33
Set FontSize 20
44
Set Width 1000
5-
Set Height 500
5+
Set Height 100
66
Set Padding 20
77

88
Type "runpod config"
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Output docs/cli/demos/ssh.gif
2+
3+
Set FontSize 20
4+
Set Width 1000
5+
Set Height 300
6+
Set Padding 20
7+
8+
Type "runpod ssh"
9+
Enter
10+
11+
Sleep 4s

docs/cli/reference.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,13 @@ Note: This CLI is not the same as runpodctl and provides a different set of feat
55
## Getting Started
66

77
![runpod --help](demos/help.gif)
8+
9+
### Configure
10+
11+
![runpod config](demos/config.gif)
12+
13+
Store your RunPod API key by running `runpod config`. Optionally you can also call the command with your API key `runpod config YOUR_API_KEY` or include the `--profile` to save multiple keys (stored under "default" profile is not specified) Credentials are stored in `~/.runpod/config.toml`.
14+
15+
![runpod ssh add-key](demos/ssh.gif)
16+
17+
Add a SSH key to you account by running `runpod ssh add-key`. To specify and existing key pass in `--key` or `--key-file` to use a file. Keys are stored in `~/.runpod/ssh/`. If no key is specified a new one will be generated and stored.

0 commit comments

Comments
 (0)