Set up TWG CLI
Set up Teamwork Graph (TWG) CLI in three steps: install, authenticate, and add agent skills. By the end, your AI coding agent will have full access to your Atlassian data — Jira work item, Confluence pages, Bitbucket repos, and more — so you can query and manage your work in plain English, no command syntax required.
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).
CLI installation mode
Use this mode when you want to install and authenticate TWG CLI directly from your terminal.
Install TWG CLI
macOS and Linux
Recommended:
curl -fsSL <https://teamwork-graph.atlassian.com/cli/install> -o twg-install.sh
bash twg-install.shIf you use Bash or zsh and want a compact shortcut, you can also run:
bash <(curl -fsSL <https://teamwork-graph.atlassian.com/cli/install)>During setup:
When consent is required, answer
yes,continue, orno.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 doctorpass, setup may offer to configure the optional Bitbucket token. If you skip it, TWG CLI is still ready for non-Bitbucket commands.On macOS, setup may enable a background helper and show a system notification for Atlassian Pty Ltd or twg. This is expected. For more information, see Configure OAuth 2.1 for Teamwork Graph CLI.
The installer completes setup and runs twg doctor automatically. To repair setup later:
twg setupTo install a specific version:
bash twg-install.sh --version 0.9.1If ~/.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, then 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
curl.exe -fsSL <https://teamwork-graph.atlassian.com/cli/install.ps1> -o twg-install.ps1
powershell -ExecutionPolicy Bypass -File .\twg-install.ps1Install — 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.
curl.exe -fsSL <https://teamwork-graph.atlassian.com/cli/install.ps1> -o twg-install.ps1
powershell -ExecutionPolicy Bypass -File twg-install.ps1The 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:
twg doctorIf Windows doesn't recognize twg, close and reopen the terminal so PATH changes are loaded, then try again.
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:
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:
twg doctorThis 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:
twg --help
twg confluence --help
twg jira --helpUpdate
Run the built-in updater:
twg updateTWG 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:
twg uninstall --dry-runUninstall asks for confirmation, revokes stored credentials, and removes the binary, installer-owned skill bundles, PATH changes, caches, consent, and all local TWG configs:
twg uninstallBeta updates
To receive pre-release updates before they reach the stable channel, use the beta channel.
First install via beta
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
twg update --channel betaSwitch back to stable
twg update --channel stableFeedback
To share feedback or report an issue, use the CLI:
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.
Was this helpful?