Sign in Start free
Documentation

workspace

Manage workspaces from the command line. hw workspace lets you create, list, and edit workspaces, view info about the active workspace, and switch between…

Last updated:
Tags:
#cli#command-line#terminal#workspaces#organization

Manage workspaces from the command line.

hw workspace lets you create, list, and edit workspaces, view info about the active workspace, and switch between workspaces. Most other commands (projects, clients, logs, timer) operate on whichever workspace is currently active.

Subcommands

hw workspace create

Create a new workspace.

bash 
hw workspace create <span class="token punctuation">[</span>flags<span class="token punctuation">]</span>

Flags:

text 
-n, --name string   workspace name

hw workspace list

List workspaces.

bash 
hw workspace list <span class="token punctuation">[</span>flags<span class="token punctuation">]</span>

Flags:

text 
-l, --limit int32   limit, number of results per page
-p, --page int32    page, the page of results

hw workspace edit

Edit a workspace.

bash 
hw workspace edit <span class="token punctuation">[</span>flags<span class="token punctuation">]</span>

Flags:

text 
-i, --id string     Workspace ID to update
-n, --name string   New name for the workspace

hw workspace info

Get info about the active workspace.

bash 
hw workspace info <span class="token punctuation">[</span>flags<span class="token punctuation">]</span>

hw workspace switch

Switch the active workspace.

bash 
hw workspace switch <span class="token punctuation">[</span>flags<span class="token punctuation">]</span>

Flags:

text 
-w, --workspace string   workspace name

Inherited flags

text 
--help   Show help for command

Examples

bash 
<span class="token comment"># Create a workspace</span>
hw workspace create <span class="token parameter variable">--name</span> <span class="token string">"Acme Corp"</span>

<span class="token comment"># List your workspaces</span>
hw workspace list

<span class="token comment"># Rename a workspace</span>
hw workspace edit <span class="token parameter variable">--id</span> <span class="token string">"workspace_id"</span> <span class="token parameter variable">--name</span> <span class="token string">"New Workspace Name"</span>

<span class="token comment"># Show info about the active workspace</span>
hw workspace info

<span class="token comment"># Switch to another workspace by name</span>
hw workspace switch <span class="token parameter variable">--workspace</span> <span class="token string">"Acme Corp"</span>

Related