From 525c48b89c51d85ea04cec4161a220914c8147dc Mon Sep 17 00:00:00 2001 From: Justin Ellingwood Date: Tue, 10 Oct 2023 14:54:03 +0100 Subject: [PATCH] docs: add organizations to generated docs --- Makefile | 2 + docs/reference.md | 94 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 96 insertions(+) diff --git a/Makefile b/Makefile index 258f672a..5547f2e7 100644 --- a/Makefile +++ b/Makefile @@ -11,6 +11,8 @@ define gen-doc-in-dir cat ./$1/koyeb_apps_*.md >> ./$1/reference.md cat ./$1/koyeb_domains.md >> ./$1/reference.md cat ./$1/koyeb_domains_*.md >> ./$1/reference.md + cat ./$1/koyeb_organizations.md >> ./$1/reference.md + cat ./$1/koyeb_organizations_*.md >> ./$1/reference.md cat ./$1/koyeb_secrets.md >> ./$1/reference.md cat ./$1/koyeb_secrets_*.md >> ./$1/reference.md cat ./$1/koyeb_services.md >> ./$1/reference.md diff --git a/docs/reference.md b/docs/reference.md index 284a385c..8c5d85a8 100644 --- a/docs/reference.md +++ b/docs/reference.md @@ -738,6 +738,100 @@ koyeb domains refresh NAME [flags] * [koyeb domains](#koyeb-domains) - Domains +## koyeb organizations + +Organization + +### Options + +``` + -h, --help help for organizations +``` + +### Options inherited from parent commands + +``` + -c, --config string config file (default is $HOME/.koyeb.yaml) + -d, --debug enable the debug output + --debug-full do not hide sensitive information (tokens) in the debug output + --force-ascii only output ascii characters (no unicode emojis) + --full do not truncate output + --organization string organization ID + -o, --output output output format (yaml,json,table) + --token string API token + --url string url of the api (default "https://app.koyeb.com") +``` + + + +* [koyeb](#koyeb) - Koyeb CLI +* [koyeb organizations list](#koyeb-organizations-list) - List organizations +* [koyeb organizations switch](#koyeb-organizations-switch) - Switch the CLI context to another organization + +## koyeb organizations list + +List organizations + +``` +koyeb organizations list [flags] +``` + +### Options + +``` + -h, --help help for list +``` + +### Options inherited from parent commands + +``` + -c, --config string config file (default is $HOME/.koyeb.yaml) + -d, --debug enable the debug output + --debug-full do not hide sensitive information (tokens) in the debug output + --force-ascii only output ascii characters (no unicode emojis) + --full do not truncate output + --organization string organization ID + -o, --output output output format (yaml,json,table) + --token string API token + --url string url of the api (default "https://app.koyeb.com") +``` + + + +* [koyeb organizations](#koyeb-organizations) - Organization + +## koyeb organizations switch + +Switch the CLI context to another organization + +``` +koyeb organizations switch [flags] +``` + +### Options + +``` + -h, --help help for switch +``` + +### Options inherited from parent commands + +``` + -c, --config string config file (default is $HOME/.koyeb.yaml) + -d, --debug enable the debug output + --debug-full do not hide sensitive information (tokens) in the debug output + --force-ascii only output ascii characters (no unicode emojis) + --full do not truncate output + --organization string organization ID + -o, --output output output format (yaml,json,table) + --token string API token + --url string url of the api (default "https://app.koyeb.com") +``` + + + +* [koyeb organizations](#koyeb-organizations) - Organization + ## koyeb secrets Secrets