| title | id | prev | next |
|---|---|---|---|
CLI Commands |
/docs/teams/cli/commands |
/docs/teams/cli/introduction |
/docs/teams/cli/contributing |
You can get help on any command with -h or --help.
e.g: tina sites --help
This will describe how to use all the commands in the sites context
- tina login - Log in / Create a tina account
- tina sites - List sites that the logged in user has access to.
- tina sites:info - Describe a given site in Tina
- tina sites:add - Adds a site into tina
- tina sites:remove - Removes a site from tina
- tina users - List users on a tina site.
- tina users:info - Describe a user in Tina
- tina users:add - Adds a user to a site in tina
- tina users:update - Updates a user's access on a site.
- tina users:remove - Removes a user from a site.
- tina users:roles:add - Adds a list of roles onto a user for a site.
- tina users:roles:remove - Removes a list of roles from a user on a site.
Log in / Create a Tina account.
Required in order to perform most actions within the CLI.
List any sites that the logged-in user has access to.
Describe a given site in Tina
--site_id <site_id> Specify a site to use (in [namespace]/[base_url] format) instead of prompting from a select list (optional)
Add a site into Tina.
--site_id <site_id> Specify a site to use (in [namespace]/[base_url] format) instead of prompting from a select list (optional)
// Your base_url might look like "[your_cloud_environment_url_1234].io" or "[your_ip]:[8888]"
Remove a site from Tina.
--site_id <site_id> Specify a site to use (in [namespace]/[base_url] format) instead of prompting from a select list (optional)
List users on a Tina site.
-t, --type <type> type of the users to include (owner or member) - defaults to all
Describe a user on a Tina site.
--email <email> Specify a user's email to use instead of prompting from a select list (optional)
--site_id <site_id> Specify a site to use (in [namespace]/[base_url] format) instead of prompting from a select list (optional)
Add a user to a Tina site.
--email <email> Specify a user's email to use instead of prompting from a select list (optional)
--site_id <site_id> Specify a site to use (in [namespace]/[base_url] format) instead of prompting from a select list (optional)
-t, --type <type> type of the users to include (owner, member) - defaults to all
-r, --role <role> a comma separated list of roles assigned to this user.
Update a user's access on a site.
--email <email> Specify a user's email to use instead of prompting from a select list (optional)
--site_id <site_id> Specify a site to use (in [namespace]/[base_url] format) instead of prompting from a select list (optional)
-t, --type <type> type of the users to include (owner, member) - defaults to all
-r, --role <role> a comma separated list of roles assigned to this user.
Remove a user from a site.
--email <email> Specify a user's email to use instead of prompting from a select list (optional)
--site_id <site_id> Specify a site to use (in [namespace]/[base_url] format) instead of prompting from a select list (optional)
Adds a list of comma-separated roles onto a user for a site
tina users:roles:add tim@tina.io editor,developer
--email <email> Specify a user's email to use instead of prompting from a select list (optional)
--site_id <site_id> Specify a site to use (in [namespace]/[base_url] format) instead of prompting from a select list (optional)
-r, --role <role> a comma separated list of roles assigned to this user.
Remove a list of comma-separated roles from a user for a site
tina users:roles:remove tim@tina.io editor,developer
--email <email> Specify a user's email to use instead of prompting from a select list (optional)
--site_id <site_id> Specify a site to use (in [namespace]/[base_url] format) instead of prompting from a select list (optional)
-r, --role <role> a comma separated list of roles assigned to this user.