This repository has been archived by the owner on Nov 10, 2017. It is now read-only.
forked from conarro/semaphore-docs-new
-
Notifications
You must be signed in to change notification settings - Fork 0
/
cli_structure.json
1 lines (1 loc) · 16.6 KB
/
cli_structure.json
1
{"name":"","commands":[{"name":"version","desc":"Display CLI version","long_desc":"","shell":"sem version","flags":[]},{"name":"login","desc":"Log in to Semaphore from the command line","long_desc":"Examples:\n\n $ sem login --auth-token abcd12345\n Your credentials have been saved to /Users/shiroyasha/.sem/credentials.\"\n\nYou can find your auth-token on the bottom of the users settings page <https://semaphoreci.com/users/edit>.\n","shell":"sem login --auth-token AUTH-TOKEN","flags":[{"name":"auth-token","required":true,"type":"string","alias":null,"default":null,"desc":""}]},{"name":"logout","desc":"Log out from semaphore","long_desc":"Examples:\n\n $ sem logout\n Logged out.\n","shell":"sem logout","flags":[]}],"namespaces":[{"name":"orgs","commands":[{"name":"list","desc":"List all organizations","long_desc":"Examples:\n\n $ sem orgs:list\n ID NAME\n 5bc7ed43-ac8a-487e-b488-c38bc757a034 renderedtext\n 99c7ed43-ac8a-487e-b488-c38bc757a034 z-fighters\n","shell":"sem orgs:list","flags":[]},{"name":"info","desc":"shows detailed information about an organization","long_desc":"Examples:\n\n $ sem orgs:info renderedtext\n ID 5bc7ed43-ac8a-487e-b488-c38bc757a034\n Name renderedtext\n Created 2017-08-01 13:14:40 +0200\n Updated 2017-08-02 13:14:40 +0200\n","shell":"sem orgs:info ORG_NAME","flags":[]},{"name":"members","desc":"list members of an organization","long_desc":"Examples:\n\n $ sem orgs:members renderedtext\n NAME\n darko\n shiroyasha\n bmarkons\n","shell":"sem orgs:members ORG_NAME","flags":[]}],"namespaces":[]},{"name":"teams","commands":[{"name":"list","desc":"list all your teams","long_desc":"Examples:\n\n $ sem teams:list\n ID NAME PERMISSION MEMBERS\n 1bc7ed43-ac8a-487e-b488-c38bc757a034 renderedtext/devs write 2 members\n 1bc7ed43-ac8a-487e-b488-c38bc757a034 renderedtext/admins write 0 members\n","shell":"sem teams:list","flags":[]},{"name":"info","desc":"show information about a team","long_desc":"Examples:\n\n $ sem teams:info renderedtext/admins\n ID 1bc7ed43-ac8a-487e-b488-c38bc757a034\n Name renderedtext/admins\n Permission edit\n Members 2 members\n Created 2017-08-01 13:14:40 +0200\n Updated 2017-08-02 13:14:40 +0200\n","shell":"sem teams:info TEAM_NAME","flags":[]},{"name":"create","desc":"create a new team","long_desc":"Examples:\n\n $ sem teams:create renderedtext/interns\n ID 1bc7ed43-ac8a-487e-b488-c38bc757a034\n Name renderedtext/interns\n Permission read\n Members 0 members\n Created 2017-08-01 13:14:40 +0200\n Updated 2017-08-02 13:14:40 +0200\n\n $ sem teams:create renderedtext/devs --permission edit\n ID 1bc7ed43-ac8a-487e-b488-c38bc757a034\n Name renderedtext/devs\n Permission edit\n Members 0 members\n Created 2017-08-01 13:14:40 +0200\n Updated 2017-08-02 13:14:40 +0200\n\n $ sem teams:create renderedtext/admins --permission admin\n ID 1bc7ed43-ac8a-487e-b488-c38bc757a034\n Name renderedtext/admins\n Permission admin\n Members 0 members\n Created 2017-08-01 13:14:40 +0200\n Updated 2017-08-02 13:14:40 +0200\n","shell":"sem teams:create TEAM_NAME","flags":[{"name":"permission","required":false,"type":"string","alias":null,"default":"read","desc":"Permission level of the team in the organization"}]},{"name":"rename","desc":"change the name of the team","long_desc":"Examples:\n\n $ sem teams:create renderedtext/interns renderedtext/juniors\n ID 1bc7ed43-ac8a-487e-b488-c38bc757a034\n Name renderedtext/juniors\n Permission read\n Members 0 members\n Created 2017-08-01 13:14:40 +0200\n Updated 2017-08-02 13:14:40 +0200\n","shell":"sem teams:rename OLD_TEAM_NAME NEW_TEAM_NAME","flags":[]},{"name":"set-permission","desc":"set the permission level of the team","long_desc":"Examples:\n\n $ sem teams:set-permission renderedtext/interns --permission edit\n ID 1bc7ed43-ac8a-487e-b488-c38bc757a034\n Name renderedtext/interns\n Permission edit\n Members 0 members\n Created 2017-08-01 13:14:40 +0200\n Updated 2017-08-02 13:14:40 +0200\n","shell":"sem teams:set-permission TEAM_NAME --permission PERMISSION","flags":[{"name":"permission","required":true,"type":"string","alias":null,"default":"read","desc":"Permission level of the team in the organization"}]},{"name":"delete","desc":"removes a team from your organization","long_desc":"Examples:\n\n $ sem teams:delete renderedtext/interns\n Team renderedtext/interns deleted.\n","shell":"sem teams:delete TEAM_NAME","flags":[]}],"namespaces":[{"name":"members","commands":[{"name":"list","desc":"list members of the team","long_desc":"Examples:\n\n $ sem teams:members:list renderedtext/interns\n NAME\n shiroyasha\n darko\n ervinb\n","shell":"sem teams:members:list TEAM_NAME","flags":[]},{"name":"add","desc":"add a user to the team","long_desc":"Examples:\n\n $ sem teams:members:add renderedtext/interns shiroyasha\n User shiroyasha added to the team.\n","shell":"sem teams:members:add TEAM_NAME USERNAME","flags":[]},{"name":"remove","desc":"remove a user from the team","long_desc":"Examples:\n\n $ sem teams:members:remove renderedtext/interns shiroyasha\n User shiroyasha removed from the team.\n","shell":"sem teams:members:remove TEAM_NAME USERNAME","flags":[]}],"namespaces":[]},{"name":"projects","commands":[{"name":"list","desc":"list projects in a team","long_desc":"Examples:\n\n $ sem team:projects:list renderedtext/devs\n NAME\n ID NAME\n 99c7ed43-ac8a-487e-b488-c38bc757a034 renderedtext/cli\n 12c7ed43-4444-487e-b488-c38bc757a034 renderedtext/api\n","shell":"sem teams:projects:list TEAM_NAME","flags":[]},{"name":"add","desc":"add a project to a team","long_desc":"Examples:\n\n $ sem team:projects:add renderedtext/devs renderedtext/cli\n Project renderedtext/cli added to the team.\n","shell":"sem teams:projects:add TEAM_NAME PROJECT_NAME","flags":[]},{"name":"remove","desc":"remove a project from the team","long_desc":"Examples:\n\n $ sem team:projects:remove renderedtext/devs renderedtext/cli\n Project renderedtext/cli removed from the team.\n","shell":"sem teams:projects:remove TEAM_NAME PROJECT_NAME","flags":[]}],"namespaces":[]},{"name":"shared-configs","commands":[{"name":"list","desc":"list shared configurations in a team","long_desc":"Examples:\n\n $ sem team:shared-configs:list renderedtext/devs\n ID NAME CONFIG FILES ENV VARS\n 99c7ed43-ac8a-487e-b488-c38bc757a034 renderedtext/tokens 1 0\n 1133ed43-ac8a-487e-b488-c38bc757a044 renderedtext/secrets 0 1\n","shell":"sem teams:shared-configs:list TEAM_NAME","flags":[]},{"name":"add","desc":"add a shared configuration to a team","long_desc":"Examples:\n\n $ sem team:shared-configs:add renderedtext/devs renderedtext/secrets\n Shared Configuration renderedtext/secrets added to the team.\n","shell":"sem teams:shared-configs:add TEAM_NAME SHARED_CONFIG_NAME","flags":[]},{"name":"remove","desc":"removes a shared Configuration from the team","long_desc":"Examples:\n\n $ sem team:shared-configs:remove renderedtext/devs renderedtext/secrets\n Shared Configuration renderedtext/secrets removed from the team.\n","shell":"sem teams:shared-configs:remove TEAM_NAME SHARED_CONFIG_NAME","flags":[]}],"namespaces":[]}]},{"name":"shared-configs","commands":[{"name":"list","desc":"list shared cofigurations","long_desc":"Examples:\n\n $ sem shared-configs:list\n ID NAME CONFIG FILES ENV VARS\n 99c7ed43-ac8a-487e-b488-c38bc757a034 renderedtext/tokens 1 0\n 1133ed43-ac8a-487e-b488-c38bc757a044 renderedtext/secrets 0 1\n","shell":"sem shared-configs:list","flags":[]},{"name":"info","desc":"show information about a shared configuration","long_desc":"Examples:\n\n $ sem shared-configs:info renderedtext/secrets\n ID 99c7ed43-ac8a-487e-b488-c38bc757a034\n Name renderedtext/secrets\n Config Files 1\n Environment Variables 0\n Created 2017-08-01 13:14:40 +0200\n Updated 2017-08-02 13:14:40 +0200\n","shell":"sem shared-configs:info SHARED_CONFIG_NAME","flags":[]},{"name":"create","desc":"create a new shared configuration","long_desc":"Examples:\n\n $ sem shared-configs:create renderedtext/secrets\n ID 99c7ed43-ac8a-487e-b488-c38bc757a034\n Name renderedtext/secrets\n Config Files 1\n Environment Variables 0\n Created 2017-08-01 13:14:40 +0200\n Updated 2017-08-02 13:14:40 +0200\n","shell":"sem shared-configs:create SHARED_CONFIG_NAME","flags":[]},{"name":"rename","desc":"rename a shared configuration","long_desc":"Examples:\n\n $ sem shared-configs:create renderedtext/secrets renderedtext/psst\n ID 99c7ed43-ac8a-487e-b488-c38bc757a034\n Name renderedtext/psst\n Config Files 1\n Environment Variables 0\n Created 2017-08-01 13:14:40 +0200\n Updated 2017-08-02 13:14:40 +0200\n","shell":"sem shared-configs:rename OLD_SHARED_CONFIG_NAME NEW_SHARED_CONFIG_NAME","flags":[]},{"name":"delete","desc":"removes a shared configuration from your organization","long_desc":"Examples:\n\n $ sem shared-configs:delete renderedtext/secrets\n Deleted shared configuration renderedtext/secrets.\n","shell":"sem shared-configs:delete SHARED_CONFIG_NAME","flags":[]}],"namespaces":[{"name":"files","commands":[{"name":"list","desc":"list files in a shared configuration","long_desc":"Examples:\n\n $ sem shared-configs:files:list renderedtext/secrets\n ID PATH ENCRYPTED?\n 77c7ed43-ac8a-487e-b488-c38bc757a034 /home/runner/a true\n 11c7ed43-bc8a-a87e-ba88-a38ba757a034 /home/runner/secrets.txt true\n","shell":"sem shared-configs:files:list SHARED_CONFIG_NAME","flags":[]},{"name":"add","desc":"add a file to the shared configuration","long_desc":"Examples:\n\n $ sem shared-configs:files:add renderedtext/secrets --local-path /tmp/secrets.json --path-on-semaphore secrets.json\n Added /home/runner/secrets.txt to renderedtext/secrets.\n","shell":"sem shared-configs:files:add SHARED_CONFIG_NAME --path-on-semaphore PATH-ON-SEMAPHORE --local-path LOCAL-PATH","flags":[{"name":"path-on-semaphore","required":true,"type":"string","alias":null,"default":null,"desc":"Path of the file in builds relative to /home/runner directory"},{"name":"local-path","required":true,"type":"string","alias":null,"default":null,"desc":"Location of the file on the local machine"}]},{"name":"remove","desc":"remove a file from the shared configuration","long_desc":"Examples:\n\n $ sem shared-configs:files:remove renderedtext/secrets --path secrets.json\n Removed /home/runner/secrets.txt from renderedtext/secrets.\n","shell":"sem shared-configs:files:remove SHARED_CONFIG_NAME --path PATH","flags":[{"name":"path","required":true,"type":"string","alias":null,"default":null,"desc":"Path of the file in builds relative to /home/runner directory"}]}],"namespaces":[]},{"name":"env-vars","commands":[{"name":"list","desc":"list environment variables in the shared configuration","long_desc":"Examples:\n\n $ sem shared-configs:files:list renderedtext/secrets\n ID NAME ENCRYPTED? CONTENT\n 9997ed43-ac8a-487e-b488-c38bc757a034 SECRET true aaa\n 1117ed43-tc8a-387e-6488-838bc757a034 TOKEN true *encrypted*\n","shell":"sem shared-configs:env-vars:list SHARED_CONFIG_NAME","flags":[]},{"name":"add","desc":"add an environment variable to the shared configuration","long_desc":"Examples:\n\n $ sem shared-configs:env-vars:add renderedtext/secrets --name TOKEN --content \"s3cr3t\"\n Added TOKEN to renderedtext/secrets.\n","shell":"sem shared-configs:env-vars:add SHARED_CONFIG_NAME --name NAME --content CONTENT","flags":[{"name":"name","required":true,"type":"string","alias":null,"default":null,"desc":"Name of the variable"},{"name":"content","required":true,"type":"string","alias":null,"default":null,"desc":"Content of the variable"}]},{"name":"remove","desc":"remove an environment variable from the shared configuration","long_desc":"Examples:\n\n $ sem shared-configs:env-vars:remove renderedtext/secrets --name TOKEN\n Removed TOKEN from renderedtext/secrets.\n","shell":"sem shared-configs:env-vars:remove SHARED_CONFIG_NAME --name NAME","flags":[{"name":"name","required":true,"type":"string","alias":null,"default":null,"desc":"Name of the variable"}]}],"namespaces":[]}]},{"name":"projects","commands":[{"name":"list","desc":"list all your projects","long_desc":"Examples:\n\n $ sem projects:list\n NAME\n ID NAME\n 99c7ed43-ac8a-487e-b488-c38bc757a034 rt/cli\n 99c7ed43-ac8a-487e-b488-c38bc757a034 rt/api\n","shell":"sem projects:list","flags":[]},{"name":"info","desc":"shows detailed information about a project","long_desc":"Examples:\n\n $ sem projects:info renderedtext/cli\n ID 99c7ed43-ac8a-487e-b488-c38bc757a034\n Name renderedtext/cli\n Created 2017-08-01 13:14:40 +0200\n Updated 2017-08-02 13:14:40 +0200\n","shell":"sem projects:info PROJECT_NAME","flags":[]},{"name":"create","desc":"create a project","long_desc":"Examples:\n\n $ sem projects:create renderedtext/cli --url [email protected]:renderedtext/cli.git\n ID 99c7ed43-ac8a-487e-b488-c38bc757a034\n Name renderedtext/cli\n Created 2017-08-01 13:14:40 +0200\n Updated 2017-08-02 13:14:40 +0200\n\n $ sem projects:create renderedtext/api --url https://github.com/renderedtext/api\n ID 99c7ed43-ac8a-487e-b488-c38bc757a034\n Name renderedtext/api\n Created 2017-08-01 13:14:40 +0200\n Updated 2017-08-02 13:14:40 +0200\n\n $ sem projects:create renderedtext/api-tests --url https://github.com/renderedtext/api\n ID 99c7ed43-ac8a-487e-b488-c38bc757a034\n Name renderedtext/api-tests\n Created 2017-08-01 13:14:40 +0200\n Updated 2017-08-02 13:14:40 +0200\n","shell":"sem projects:create PROJECT_NAME --url URL","flags":[{"name":"url","required":true,"type":"string","alias":null,"default":null,"desc":"Git url to the repository"}]}],"namespaces":[{"name":"shared-configs","commands":[{"name":"list","desc":"list shared configurations on a project","long_desc":"Examples:\n\n $ sem projects:shared-configs:list renderedtext/cli\n ID NAME CONFIG FILES ENV VARS\n 99c7ed43-ac8a-487e-b488-c38bc757a034 renderedtext/tokens 1 0\n 99c7ed43-ac8a-487e-b488-c38bc757a034 renderedtext/secrets 0 1\n","shell":"sem projects:shared-configs:list PROJECT_NAME","flags":[]},{"name":"add","desc":"attach a shared configuration to a project","long_desc":"Examples:\n\n $ sem projects:shared-configs:add renderedtext/cli renderedtext/secrets\n Shared Configuration renderedtext/secrets added to the project.\n","shell":"sem projects:shared-configs:add PROJECT_NAME SHARED_CONFIG_NAME","flags":[]},{"name":"remove","desc":"removes a shared configuration from the project","long_desc":"Examples:\n\n $ sem projects:shared-configs:remove renderedtext/cli renderedtext/secrets\n Shared Configuration renderedtext/secrets removed from the project.\n","shell":"sem projects:shared-configs:remove PROJECT_NAME SHARED_CONFIG_NAME","flags":[]}],"namespaces":[]},{"name":"files","commands":[{"name":"list","desc":"list configuration files for a project","long_desc":"Examples:\n\n $ sem projects:files:list renderedtext/cli\n ID PATH ENCRYPTED?\n 77c7ed43-ac8a-487e-b488-c38bc757a034 /etc/a true\n 11c7ed43-bc8a-a87e-ba88-a38ba757a034 /var/secrets.txt true\n","shell":"sem projects:files:list PROJECT_NAME","flags":[]}],"namespaces":[]},{"name":"env-vars","commands":[{"name":"list","desc":"list environment variables on project","long_desc":"Examples:\n\n $ sem projects:env-vars:list renderedtext/cli\n ID NAME ENCRYPTED? CONTENT\n 9997ed43-ac8a-487e-b488-c38bc757a034 SECRET false aaa\n 1117ed43-tc8a-387e-6488-838bc757a034 TOKEN true *encrypted*\n","shell":"sem projects:env-vars:list PROJECT_NAME","flags":[]}],"namespaces":[]}]}]}