Workspace
The `workspace` command
Last updated
Was this helpful?
The `workspace` command
Last updated
Was this helpful?
The workspace command is used to manage workspaces on keyshade. A workspace is a collection of projects, environments, secrets, variables, and roles. It has a set of subcommands:
: This command is used to create a new workspace.
: This command is used to delete an existing workspace.
: This command is used to export all projects, environments, secrets, variables, and roles of a workspace into JSON format.
: This command is used to fetch a particular workspace.
: This command is used to fetch all the workspaces you have access to.
: This command is used to perform a full-text search for projects, secrets, variables, and environments in a workspace.
: This command is used to update an existing workspace.
createThese are the options supported by the create command:
-n, --name <name>The name of the workspace. This is a required field. If the name is not provided via the command line option, the user will be prompted to enter it interactively.
-i, --icon <icon>The icon to be used for this workspace (optional).
deleteThese are the arguments supported by the delete command:
<workspace slug>Slug of the workspace which you want to delete.
exportThese are the arguments supported by the export command:
<workspace slug>Slug of the workspace which you want to export.
These are the options supported by the export command:
-s, --save-to-file <file>Saves the exported data to a file. If not provided, the data will be printed to the console.
getThese are the arguments supported by the get command:
<workspace slug>The slug of the workspace you want to fetch.
listThese are the options supported by the list command:
-p, --page <int>Index of the page.
-l, --limit <int>Total number of items per page.
-o, --order <string>Order to sort by - either ascending (ASC) or descending (DESC).
--sort, --sort <string>Field to sort by.
-s, --search <string>Search term.
searchThese are the arguments supported by the search command:
<workspace slug>Slug of the workspace which you want to search for.
<search term>The search term you want to use for searching.
updateUsageThese are the arguments supported by the update command:
<workspace slug>The slug of the workspace you want to update.
These are the options supported by the update command:
-n, --name <name>The new name for the workspace.
-i, --icon <icon>The new icon for the workspace.
At least one of the options (name or icon) must be provided to perform an update.