mirror of
https://github.com/ohmyzsh/ohmyzsh.git
synced 2024-11-30 09:40:09 +00:00
docs(scw): update scw-plugin README.md
This commit is contained in:
parent
d96afac8d0
commit
96d7c9fd57
1 changed files with 47 additions and 4 deletions
|
@ -1,7 +1,50 @@
|
||||||
## Scaleway CLI autocomplete plugin
|
# SCW
|
||||||
|
|
||||||
|
This plugin adds functions to manage your Scaleway profile
|
||||||
|
|
||||||
|
|
||||||
|
## Prerequisites
|
||||||
|
|
||||||
|
Scaleway CLI (scw) should be installed. You can install it from https://github.com/scaleway/scaleway-cli.
|
||||||
|
|
||||||
|
Copy and paste the code into your Zsh shell configuration file (e.g., .zshrc).
|
||||||
|
Source the updated configuration file or restart your shell.
|
||||||
|
|
||||||
|
|
||||||
|
```bash
|
||||||
|
plugins=(... scw)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Functions
|
||||||
|
|
||||||
|
| Commands | Description |
|
||||||
|
| :---------------: |:---------------|
|
||||||
|
| scw_upgrade | Update your Scaleway CLI version if needed. |
|
||||||
|
| sgp | Displays the current Scaleway profile. |
|
||||||
|
| ssp <profilename> | Sets the Scaleway profile. If no profile name is provided, fallback to the curent active profile set in your
|
||||||
|
configuration file. |
|
||||||
|
| scw_profiles | Displays a list of available Scaleway profiles. |
|
||||||
|
| scw_config_path | Returns the path to the Scaleway CLI configuration file (config.yaml). |
|
||||||
|
|
||||||
|
In addition to setting the `SCW_PROFILE` environment variable, `ssp` also sets the following variables: `SCW_DEFAULT_ORGANIZATION_ID`,
|
||||||
|
`SCW_DEFAULT_PROJECT_ID`, `SCW_DEFAULT_REGION`, `SCW_DEFAULT_ZONE`, `SCW_API_URL`.
|
||||||
|
Additionnally, if `SCW_EXPORT_TOKENS` is set to "true", `SCW_ACCESS_KEY` and `SCW_SECRET_KEY` are also exported.
|
||||||
|
|
||||||
|
|
||||||
|
## Customizations
|
||||||
|
|
||||||
|
| Commands | Description |
|
||||||
|
| :---------------: |:---------------|
|
||||||
|
| SHOW_SCW_PROMPT | Controls whether to display the Scaleway profile information in the shell prompt. Set this variable to false if you don't
|
||||||
|
want to show the profile information. |
|
||||||
|
| ZSH_THEME_SCW_PROFILE_PREFIX | sets the prompt prefix. Defaults to `<scw:` |
|
||||||
|
| ZSH_THEME_SCW_PROFILE_SUFFIX | Set the prompt suffix. Default to `>` |
|
||||||
|
|
||||||
|
|
||||||
|
## Scaleway CLI Autocompletion
|
||||||
|
|
||||||
|
If Scaleway CLI autocompletion is not already loaded, the code automatically loads the autocompletion script for the scw command. This enables
|
||||||
|
autocompletion for all Scaleway CLI commands.
|
||||||
|
|
||||||
[scw](https://github.com/scaleway/scaleway-cli): Manage Bare Metal servers from Command Line (as easily as with Docker)
|
|
||||||
|
|
||||||
- Adds autocomplete options for all `scw` commands.
|
|
||||||
|
|
||||||
Maintainer : Manfred Touron ([@moul](https://github.com/moul))
|
|
||||||
|
|
Loading…
Reference in a new issue