CLI overview

hq is the command-line companion to HQ. Your team machines keep running in HQ; hq lets this computer reach them without copying keys or passwords around.

What hq does

• Sign in with hq login. You approve this computer in HQ in your browser, and the login renews itself on this device.
• Attach to an HQ session with hq attach. You follow it live in your own terminal; the person who started it is the only one who types.
• Forward a port with hq forward, so a dev server on the team machine answers on localhost here.
• Wake a team with hq up, so a sleeping machine is ready before you attach.

To work on a team's files in your editor, use the AI Workforce One HQ extension for VS Code, Cursor, Windsurf or VSCodium.

Before you start

• Node.js 20 or newer on this computer.
• An HQ account in at least one organization.
• Developer access on for your organization. An organization owner turns it on in HQ, under Settings, Security, Developer access.
• Access to the team. Attaching needs viewer, editor or owner access to the team. Port forwarding needs editor or owner access and an active plan. hq status shows what each team allows you.

Quick start

1. Install

   npm i -g @aiworkforceoneofficial/hq --ignore-scripts

2. Sign in

   Run hq login and approve this computer in the browser window it opens.

3. See your teams

   Run hq status. Each team has an hq-… name you use in every other command.

4. Connect

   Attach to a session with hq attach, or forward a port with hq forward.

Next