Skip to content

doc: add links to CLI namespace reference documentation on README #1209

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 13, 2020
Merged

doc: add links to CLI namespace reference documentation on README #1209

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b2ead38
doc: add links to CLI namespace reference documentation on README
remyleone Jul 13, 2020
ee998dc
Merge branch 'v2' into readme_links
remyleone Jul 13, 2020
96fa27b
Update README.md
remyleone Jul 13, 2020
be6f8bc
Merge branch 'v2' into readme_links
remyleone Jul 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 37 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

<!--- TODO:
Expand Down Expand Up @@ -136,15 +126,49 @@ 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
# Getting Started

## Setup your configuration

## Create an instance server
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.

## Basic commands

```
# Create an instance server
scw instance server create type=DEV1-S image=ubuntu_focal zone=fr-par-1 tags.0="scw-cli"

# List your servers
scw instance server list

# 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
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
```

TODO: Add more examples here.
# Reference documentation

| Namespace | Description | Documentation |
|----------------|-----------------------------------------|-------------------------------------------------------------------------------------------------------|
| `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/) |


## Build it yourself

Expand Down Expand Up @@ -175,10 +199,6 @@ docker run -i --rm scaleway/cli

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

# Tutorials

TODO: Add a list of tutorials here.

# Development

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