Set up TWG CLI

1. CLI installation mode

Use this mode when you want to install and authenticate TWG CLI directly from your terminal.

Before you begin

• You need macOS (arm64 or x64), Linux (x64), or Windows (arm64 or x64).
• You need an Atlassian account with access to the products you want to use.
• To use TWG CLI through an agent after CLI setup, you need an AI coding agent installed on your computer.

The TWG CLI binary does not require a separate runtime (for example, no Node.js).

Step 1: Install TWG CLI

macOS and Linux

Recommended:

1
2
curl -fsSL https://teamwork-graph.atlassian.com/cli/install -o twg-install.sh
bash twg-install.sh

If you use Bash or zsh and want a compact shortcut, you can also run:

1
2
bash <(curl -fsSL https://teamwork-graph.atlassian.com/cli/install)

During setup:

• When consent is required, answer yes, continue, or no.
• After consent, enter your Atlassian account email and default site prefix or domain, for example example or example.atlassian.net.
• The installer saves email and site before token setup.
• Setup installs and refreshes TWG agent skills.
• The installer opens the token page. Generate a token in the browser, copy it, then press Enter — the installer reads it from the OS clipboard. If clipboard access is unavailable, it falls back to a masked paste prompt.
• If a Bitbucket token is not already configured, setup offers the same clipboard-confirmed flow for the optional Bitbucket token.
• If you use a clipboard history manager, clear it after setup.

The installer completes setup and runs twg doctor automatically. To repair setup later:

1
2
twg setup

To install a specific version:

1
2
bash twg-install.sh --version 0.9.1

If ~/.local/bin is not in your PATH, the installer prints the exact line to add to your shell profile.

Homebrew (macOS)

1
2
brew tap atlassian/twg
brew install twg
twg setup

Windows

Install — PowerShell

1
2
curl.exe -fsSL https://teamwork-graph.atlassian.com/cli/install.ps1 -o twg-install.ps1
powershell -ExecutionPolicy Bypass -File .\twg-install.ps1

Install — Command Prompt (cmd)

1
2
curl.exe -fsSL https://teamwork-graph.atlassian.com/cli/install.ps1 -o twg-install.ps1
powershell -ExecutionPolicy Bypass -File twg-install.ps1

The Windows installer performs the same setup as macOS and Linux: binary install, checksum verification, consent, email and site save, skill install, token login, and doctor verification.

Setup asks for:

Credentials are saved to ~/.config/twg/auth.conf and reused across sessions. For re-authentication, token management, and CI/CD environment variables, see Authentication.

2. Agent installation mode

Use this mode when you want your AI coding agent to install TWG CLI, authenticate, and set up agent skills for you.

Copy the following prompt and paste it into your agent:

1
2
Install and set up TWG CLI for me using the official agent instructions at https://teamwork-graph.atlassian.com/cli/AGENTS.md

Your agent follows the hosted instructions, installs the binary, waits for consent, asks for email and site, completes authentication, installs TWG skills, and verifies setup with twg doctor.

Verify setup

Run:

1
2
twg doctor

This checks authentication, connectivity, and build info. It works the same on macOS, Linux, PowerShell, and cmd.

Try it

Your AI coding agent can now access your Atlassian data across Jira, Confluence, Bitbucket, and more. Describe what you want in plain language and your agent handles the rest:

• "Summarize the work I did this week"
• "What are my open Jira issues?"
• "Create a Confluence page about our Q2 goals"
• "Show the current sprint for my team"

See Agent examples for more prompts to try.

Quick start video

Introduction to Teamwork Graph CLI — walks through installation, authentication, and using the agent skill to query work across Atlassian products.

Update

macOS/Linux — use the built-in updater:

1
2
twg update

macOS (Homebrew):

1
2
brew update && brew upgrade twg

Windows (PowerShell or cmd) — re-run the install command from the Windows section above.

twg update and the installers refresh installed skill files automatically when they can detect existing TWG skill installs.

Feedback

To share feedback or report an issue, use the CLI:

1
2
twg feedback --summary "<short title>"

Or submit feedback using the TWG CLI feedback form.

Admin opt-out

Organization admins can request to opt their organization out of Teamwork Graph CLI access. Submit a request using the TWG CLI admin opt-out form. The team will process your request within 24 hours.

Next steps

• Authentication
• Agent skills
• Agent examples