CLI REFERENCE

Command guide

How to use it: each command syntax and its use

htb help [COMMAND]: Show the full local guide. Pass a command path such as 'ticket create' for its options and examples.

htb version: Show the installed CLI version when reporting an issue or checking an upgrade.

htb config set-server URL: Save the HTB server URL used by all subsequent commands on this computer.
htb auth login [--issuer URL --client-id ID --audience ID]: Open the browser sign-in flow. Normally the server provides the connection settings; the optional flags are only for an advanced manual setup.
htb auth status: Show whether you are connected, the projects you can access, and the project currently selected.

htb project list: List projects you can access. The star marks the current project.
htb project status: Show progress for every accessible project, including user stories, all tickets, and their status breakdown.
htb project create --key KEY --name NAME [--description TEXT]: Create a project and select it immediately. KEY identifies the project in commands and ticket references such as HTB-1; lowercase input is converted to uppercase.
htb project use KEY: Select the project used when a command does not include --project.
htb project members [--project KEY]: List project members. Administrators can use member IDs to change roles or remove access.
htb project member set-role --user ID --role read|write|admin [--project KEY]: Change a non-owner member role. The project owner cannot be demoted.
htb project member remove --user ID [--project KEY]: Remove a non-owner member from a project.

htb feature create --key KEY --name NAME [--project KEY] [--description TEXT] [--due-date YYYY-MM-DD]: Create a roadmap feature. It uses the current project unless --project is provided; --due-date is optional.

htb ticket create --title TITLE [--type user_story|technical_task|bug|incident] [--project KEY] [--parent REF] [--related REF] [--feature KEY] [--description TEXT] [--priority low|normal|high|urgent] [--label TAG]: Create a ticket in the current project by default. A technical task must use --parent with a user-story reference; repeat --label to attach several labels.
htb ticket list [--project KEY] [--feature KEY] [--status STATUS] [--priority PRIORITY] [--label LABEL] [--query TEXT] [--tree] [--json|--csv]: List tickets from the current project. Combine feature, status, priority, label, and text filters; include child tickets with --tree or select JSON/CSV for scripts.
htb ticket show REF: Display one ticket, including its status, relationships, labels, and current version.
htb ticket update --version N [--title TITLE] [--description TEXT] [--status open|in_progress|review|blocked|done] [--priority low|normal|high|urgent] [--feature KEY] REF: Update a ticket safely. Use the version shown by 'htb ticket show REF' so concurrent changes are not overwritten.
htb ticket comment REF TEXT: Add a comment to a ticket.
htb ticket comments REF: Read ticket comments with their author and timestamp.

htb ticket publish REF | htb ticket unpublish REF: Make a user story visible to clients or hide it again; project admin only.
htb ticket client-comments REF: Read the public conversation on a published user story.
htb ticket client-comment REF TEXT: Reply to clients without exposing internal ticket comments.

htb ticket activity REF: Read the ticket audit activity.
htb ticket claim REF: Assign a ticket to yourself and move an open ticket to in progress.
htb ticket release REF: Remove your claim from a ticket so another person can take it.
htb ticket versions REF: List the saved revisions of a ticket.
htb ticket restore --version N REF REVISION: Restore a saved revision only when the ticket is still at version N, preventing accidental overwrites.

htb invite create [--project KEY] [--role read|write|admin] [--expires-at RFC3339]: Create a shareable invitation for the current project or --project. Choose the member role and an expiry time; it defaults to 7 days.
htb invite accept CODE: Accept an invitation code and gain access to its project.
htb invite list [--project KEY]: List active invitations without exposing their codes.
htb invite revoke ID [--project KEY]: Revoke an active invitation.