Sign in Start free
Documentation

client

Manage workspace clients from the command line. hw client lets you create, list, edit, and delete clients in your active workspace. Clients can then be…

Last updated:
Tags:
#cli#command-line#terminal#clients#customer-management

Manage workspace clients from the command line.

hw client lets you create, list, edit, and delete clients in your active workspace. Clients can then be linked to projects.

Subcommands

hw client create

Create a client.

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

Flags:

text 
-n, --name string   name of the client

hw client list

List clients.

bash 
hw client 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 client edit

Update a client.

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

Flags:

text 
-i, --id string     Client ID to update
-n, --name string   New name for the client

hw client delete

Delete a client.

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

Flags:

text 
-i, --id string   ID of the client to delete

Inherited flags

text 
--help   Show help for command

Examples

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

<span class="token comment"># Create a client using the shorthand flag</span>
hw client create <span class="token parameter variable">-n</span> <span class="token string">"Demo Solutions"</span>

<span class="token comment"># List clients</span>
hw client list

<span class="token comment"># Rename a client</span>
hw client edit <span class="token parameter variable">--id</span> <span class="token string">"client_id"</span> <span class="token parameter variable">--name</span> <span class="token string">"New Client Name"</span>

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

Related