Developer
News and Updates
Get Support
Sign in
Get Support
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Sign in
DOCUMENTATION
Cloud
Data Center
Resources
Sign in
Last updated Jun 26, 2026

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.
  • Setup installs and refreshes TWG agent skills.
  • The installer opens your browser to sign in with OAuth. Sign in to Atlassian, select the site you want to authorize (auto-selected if you have access to only one), review the requested permissions, and select Accept.
  • After core setup and twg doctor pass, setup may offer to configure the optional Bitbucket token. If you skip it, TWG CLI is still ready for non-Bitbucket commands.

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

1
2
twg setup

On macOS, setup may enable a background helper and show a system notification for Atlassian Pty Ltd or twg. This is expected; see Configure OAuth 2.1 for details.

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.

Windows

Windows: SmartScreen may warn about the installer — choose More info → Run anyway. Pre-release builds may not yet use a production code signature; that is expected until generally available signed binaries ship.

Use Windows PowerShell or Command Prompt for Windows installation. Don't run the Windows installer from Git Bash, MINGW, WSL, or another bash-like shell.

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)

curl is built into Windows 10 1803 and later. If you're on an older version, use the PowerShell method above instead.

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, skill install, OAuth login, and doctor verification.

During setup, the installer:

  • Opens your browser to sign in with OAuth. In the browser, select the site you want to authorize (auto-selected if you have access to only one), review the requested permissions, and select Accept.
  • Offers the optional Bitbucket token step. You can skip this unless you plan to use Bitbucket-specific commands.

Credentials are saved in the TWG config directory and reused across sessions. For re-authentication and the Bitbucket token, see Configure OAuth 2.1.

After installation, open a new PowerShell or Command Prompt window and run:

1
2
twg doctor

If Windows doesn't recognize twg, close and reopen the terminal so PATH changes are loaded, then try again.

2. Agent installation mode

Use this mode when you want an 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/setup TWG using https://teamwork-graph.atlassian.com/cli/AGENTS.md

The agent should use that hosted AGENTS.md directly. There are no separate agent-specific install URLs.

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.

To discover command syntax directly in the terminal, run:

1
2
twg --help
twg confluence --help
twg jira --help

Update

Run the built-in updater:

1
2
twg update

TWG CLI checks for updates during normal use and notifies you when a new version is available.

Uninstall

Preview the files and configs that would be removed:

1
2
twg uninstall --dry-run

Uninstall asks for confirmation, revokes stored credentials, and removes the binary, installer-owned skill bundles, PATH changes, caches, consent, and all local TWG configs:

1
2
twg uninstall

Beta updates

To receive pre-release updates before they reach the stable channel, use the beta channel.

First install via beta

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

Installs from the beta channel record the channel preference automatically — future twg update calls continue to check the beta channel.

Switch an existing install to beta

1
2
twg update --channel beta

Switch back to stable

1
2
twg update --channel stable

Feedback

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

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

The command opens a prefilled public form in interactive terminals. In agent, structured-output, or non-interactive runs, it prints the form URL instead. Your configured TWG account email is prefilled when available. Review the details, provide an email if needed, complete reCAPTCHA, and submit the form. TWG authentication is not required.

You can also open the TWG CLI feedback form directly.

Next steps

Rate this page: