Sign in Start free
Documentation

project

Manage workspace projects from the command line.

Last updated:
Tags:
#cli#command-line#terminal#projects

Manage workspace projects from the command line.

hw project lets you create, list, edit, and delete projects in your active workspace. Projects can be linked to a client by ID.

Subcommands

hw project create

Create a new project.

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

Flags:

text 
-i, --clientId string   client id
-n, --name string       project name

hw project list

List projects.

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

Flags:

text 
-q, --jq expression   Filter JSON output using a jq expression
    --json strings    Output JSON with the specified fields
-l, --limit uint32    limit, number of results per page (default 25)
-p, --page uint32     page, the page of results (default 1)

hw project edit

Edit a project.

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

Flags:

text 
-i, --id string     Project ID to update
-n, --name string   New name for the project

hw project delete

Delete a project.

bash 
hw project delete <span class="token punctuation">[</span>flags<span class="token punctuation">]</span>

Flags:

text 
-i, --id string   project id

Inherited flags

text 
--help   Show help for command

Examples

bash 
<span class="token comment"># Create a project linked to a client</span>
hw project create <span class="token parameter variable">--name</span> <span class="token string">"Website Redesign"</span> <span class="token parameter variable">--clientId</span> <span class="token string">"client_id"</span>

<span class="token comment"># Create a project using shorthand flags</span>
hw project create <span class="token parameter variable">-n</span> <span class="token string">"Mobile App"</span> <span class="token parameter variable">-i</span> <span class="token string">"client_id"</span>

<span class="token comment"># List projects</span>
hw project list

<span class="token comment"># Rename a project</span>
hw project edit <span class="token parameter variable">--id</span> <span class="token string">"project_id"</span> <span class="token parameter variable">--name</span> <span class="token string">"New Project Name"</span>

<span class="token comment"># Delete a project by id</span>
hw project delete <span class="token parameter variable">--id</span> <span class="token string">"project_id"</span>

Related