Skip to content

Commit

Permalink
feat: add to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
flash-singh committed Apr 11, 2022
1 parent 9b69381 commit 0986e69
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,24 @@
runpodctl is a CLI tool to automate / manage GPU pods for [rundpod.io](https://runpod.io).

# install
coming soon...
get latest binary from [releases](releases)

# how to use
Visit [docs](doc/runpodctl.md) for details of all commands.

First configure the API key. You can get API key from [runpod](https://runpod.io/client/settings).
`runpodctl config --api-key={key}`

```
runpodctl config --api-key={key}
```
Get all pods:
```
runpodctl get pod
```
Stop a pod:
```
runpodctl stop pod {podId}
```
Start a pod with bid (only for spot pods). The bid price you set is the price you will pay if not outbid:
```
runpodctl start pod {podId} --bid=0.3
```

0 comments on commit 0986e69

Please sign in to comment.