From b2ead383f0e5bc751024ad0feb95fe261156c777 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9my=20L=C3=A9one?= Date: Mon, 13 Jul 2020 14:16:01 +0200 Subject: [PATCH 1/2] doc: add links to CLI namespace reference documentation on README --- README.md | 20 +++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ae3e64256c..3336bf0898 100644 --- a/README.md +++ b/README.md @@ -136,7 +136,23 @@ docker run -i --rm scaleway/cli:v2.0.0-beta.4 See more in-depth information about running the CLI in Docker [here](./docs/docker.md) -# Examples +# CLI reference documentation + +| Namespace | Description | Reference link | +|----------------|-----------------------------------------|-------------------------------------------------------------------------------------------------------| +| `account` | Account API | [CLI](./docs/commands/account.md) | +| `autocomplete` | Autocomplete related commands | [CLI](./docs/commands/autocomplete.md) | +| `config` | Config file management | [CLI](./docs/commands/config.md) | +| `feedback` | Send feedback to the Scaleway CLI Team! | [CLI](./docs/commands/feedback.md) | +| `info` | Get info about current settings | [CLI](./docs/commands/info.md) | +| `baremetal` | Baremetal API | [CLI](./docs/commands/baremetal.md) [API](https://developers.scaleway.com/en/products/baremetal/api/) | +| `init` | Initialize the config | [CLI](./docs/commands/init.md) | +| `instance` | Instance API | [CLI](./docs/commands/instance.md) [API](https://developers.scaleway.com/en/products/instance/api/) | +| `k8s` | Kapsule API | [CLI](./docs/commands/k8s.md) [API](https://developers.scaleway.com/en/products/k8s/api/) | +| `marketplace` | Marketplace API | [CLI](./docs/commands/marketplace.md) | +| `object` | Object-storage utils | [CLI](./docs/commands/object.md) [API](https://www.scaleway.com/en/docs/object-storage-feature/) | +| `rdb` | Database RDB API | [CLI](./docs/commands/rdb.md) [API](https://developers.scaleway.com/en/products/rdb/api/) | +| `registry` | Container registry API | [CLI](./docs/commands/registry.md) [API](https://developers.scaleway.com/en/products/registry/api/) | ## Create an instance server @@ -144,8 +160,6 @@ See more in-depth information about running the CLI in Docker [here](./docs/dock scw instance server create type=DEV1-S image=ubuntu_focal zone=fr-par-1 tags.0="scw-cli" ``` -TODO: Add more examples here. - ## Build it yourself ### Build Locally From 96fa27b3e2e568d82345c846a1bb86610f0daee8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9my=20L=C3=A9one?= Date: Mon, 13 Jul 2020 15:40:58 +0200 Subject: [PATCH 2/2] Update README.md --- README.md | 60 ++++++++++++++++++++++++++++++------------------------- 1 file changed, 33 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 3336bf0898..025d7db442 100644 --- a/README.md +++ b/README.md @@ -13,16 +13,6 @@ Scaleway is a single way to create, deploy and scale your infrastructure in the If you are looking for a stable version, [see the version 1](https://github.com/scaleway/scaleway-cli/tree/master). -# Getting Started - -After you [installed](#Installation) the latest release just run the initialization command and let yourself be guided! :dancer: - -```bash -scw init -``` - -It will set up your profile, the authentication, and the auto-completion. - # Installation