Skip to content

Commit dcd012a

Browse files
authored
doc: add links to CLI namespace reference documentation on README (#1209)
1 parent 0e781eb commit dcd012a

File tree

1 file changed

+37
-17
lines changed

1 file changed

+37
-17
lines changed

README.md

Lines changed: 37 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,6 @@ Scaleway is a single way to create, deploy and scale your infrastructure in the
1313

1414
If you are looking for a stable version, [see the version 1](https://github.com/scaleway/scaleway-cli/tree/master).
1515

16-
# Getting Started
17-
18-
After you [installed](#Installation) the latest release just run the initialization command and let yourself be guided! :dancer:
19-
20-
```bash
21-
scw init
22-
```
23-
24-
It will set up your profile, the authentication, and the auto-completion.
25-
2616
# Installation
2717

2818
<!--- TODO:
@@ -136,15 +126,49 @@ docker run -i --rm scaleway/cli:v2.0.0-beta.4
136126

137127
See more in-depth information about running the CLI in Docker [here](./docs/docker.md)
138128

139-
# Examples
129+
# Getting Started
130+
131+
## Setup your configuration
140132

141-
## Create an instance server
133+
After you [installed](#Installation) the latest release just run the initialization command and let yourself be guided! :dancer:
134+
135+
```bash
136+
scw init
137+
```
138+
139+
It will set up your profile, the authentication, and the auto-completion.
140+
141+
## Basic commands
142142

143143
```
144+
# Create an instance server
144145
scw instance server create type=DEV1-S image=ubuntu_focal zone=fr-par-1 tags.0="scw-cli"
146+
147+
# List your servers
148+
scw instance server list
149+
150+
# Create a Kubernetes cluster named foo with cilium as CNI, in version 1.17.4 and with a pool named default composed of 3 DEV1-M and with 2 tags
151+
scw k8s cluster create name=foo version=1.17.4 pools.0.size=3 pools.0.node-type=DEV1-M pools.0.name=default tags.0=tag1 tags.1=tag2
145152
```
146153

147-
TODO: Add more examples here.
154+
# Reference documentation
155+
156+
| Namespace | Description | Documentation |
157+
|----------------|-----------------------------------------|-------------------------------------------------------------------------------------------------------|
158+
| `account` | Account API | [CLI](./docs/commands/account.md) |
159+
| `autocomplete` | Autocomplete related commands | [CLI](./docs/commands/autocomplete.md) |
160+
| `config` | Config file management | [CLI](./docs/commands/config.md) |
161+
| `feedback` | Send feedback to the Scaleway CLI Team! | [CLI](./docs/commands/feedback.md) |
162+
| `info` | Get info about current settings | [CLI](./docs/commands/info.md) |
163+
| `baremetal` | Baremetal API | [CLI](./docs/commands/baremetal.md) / [API](https://developers.scaleway.com/en/products/baremetal/api/) |
164+
| `init` | Initialize the config | [CLI](./docs/commands/init.md) |
165+
| `instance` | Instance API | [CLI](./docs/commands/instance.md) / [API](https://developers.scaleway.com/en/products/instance/api/) |
166+
| `k8s` | Kapsule API | [CLI](./docs/commands/k8s.md) / [API](https://developers.scaleway.com/en/products/k8s/api/) |
167+
| `marketplace` | Marketplace API | [CLI](./docs/commands/marketplace.md) |
168+
| `object` | Object-storage utils | [CLI](./docs/commands/object.md) / [API](https://www.scaleway.com/en/docs/object-storage-feature/) |
169+
| `rdb` | Database RDB API | [CLI](./docs/commands/rdb.md) / [API](https://developers.scaleway.com/en/products/rdb/api/) |
170+
| `registry` | Container registry API | [CLI](./docs/commands/registry.md) / [API](https://developers.scaleway.com/en/products/registry/api/) |
171+
148172

149173
## Build it yourself
150174

@@ -175,10 +199,6 @@ docker run -i --rm scaleway/cli
175199

176200
See more in-depth information about running the CLI in Docker [here](./docs/docker.md)
177201

178-
# Tutorials
179-
180-
TODO: Add a list of tutorials here.
181-
182202
# Development
183203

184204
This repository is at its early stage and is still in active development.

0 commit comments

Comments
 (0)