List of Commands
This document covers the commands supplied by
skycli. Currently there are 5 groups of them:app: all commands under this are to interact or manage apps on Skygearauth: for authentication operations onskycli, like signing upconfig: for Skygear cluster operations onskyclisecret: to manage secrets of a Skygear appdomain: to manage custom domains of a Skygear appversion: the only group where itself is a valid command, with no sub-commands
Type in
skygear --help to print out these groups. To check the sub-commands, enter skygear <group-name> --help.When you are in some directories with no
skygear.yaml inside, while you need to provide a Skygear app name to a skycli command, you can do this via the use of --app.You won't need to do this when there exists a
skygear.yaml in the current directory as skycli automatically looks for that and will parse the app value (i.e. an app's name) inside.Whenever you need to interact with a Skygear app, go for these commands. Unless you are dealing with secrets, which should be done with the
skygear secret commands. Most of them requires you to provide your app name.Will ask you questions regarding the properties (e.g. name) of the app, then create one for you.
List all apps that you have access right.
Kicks start a scaffolding for a Skygear app from our app templates.
Deploys a Skygear app to your connected cluster. Requires a
skygear.yaml at the same level defining the deployment.Output your app's metadata and secrets.
Allow you to edit your app's metadata and secrets.
Add a collaborator to your app by sending them an email.
Remove a collaborator with his/her email.
List collaborator of your Skygear app.
List out all templates of your Skygear app.
Upload all valid templates in the folder
templates a level under your skygear.yaml's residence.Download all templates of your Skygear app.
Write your Skygear app's Kubernetes credentials to your local config, normally at
~/.kube/config. Useful for things like check the logging of your pod/service.Print out your app's
ExecCredential.Remove your app's Kubernetes credentials from your local config.
All authentication operations on
skycli are done by these commands.Log in with email to use privileged commands of
skycli.Clean the account state of
skycli.Create a Skygear account in connected cluster. After you have provided the credentials, you will have to verify your email before you can use the account
Print out the metadata of the connected cluster.
Connect to a Skygear cluster by answering a set of questions.
List available Skygear cluster contexts.
Activate specific Skygear cluster context.
All about secret management under a Skygear app. Ensure app name is provided!
List out all secrets under the specified app.
Create a secret with the given name-value pair.
By name, delete an existing secret.
While Skygear gives your app a default domain with the suffix
.skygearapp.com, you can replace this with a custom domain (that you own).Register a custom domain to your Skygear app. Lines of DNS records will be outputted after executing the command, be sure to add them to your DNS provider. Then, verify the domain to complete the flow.
List all added custom domain of your Skygear app.
Display the metadata of a registered custom domain.
Verify an added custom domain.
Update verified custom domain.
Remove a custom domain from your Skygear app.
No sub-commands, directly run this to print out your
skycli version.Last modified 3yr ago