Get started with TWG CLI

This guide walks you through the three steps to get TWG CLI working with your AI coding agent. Complete these steps in order.

はじめる前に

• 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.

• You need an AI coding agent installed on your computer (for example, Cursor, Claude Code, or Codex).

• You need EAP access to TWG CLI.

Step 1: Install TWG CLI

macOS or Linux

1. Open Terminal.

2. 次のコマンドを実行します。

1. Follow the prompts. The installer detects your platform, verifies the download, and places the binary in ~/.local/bin.

If ~/.local/bin isn't in your PATH, the installer shows you the exact line to add to your shell profile. Restart your terminal after making that change.

Tip: The install script automatically guides you through authentication and skills setup. If prompted and you complete those steps during install, you can skip Steps 2 and 3 below.

macOS with Homebrew

1. 次のコマンドを実行します。

Note: The Homebrew install places the twg binary on your system but does not run twg login or twg skills install automatically. After the install completes, continue to Steps 2 and 3 to finish your setup.

Windows

Placeholder steps (do not publish as-is):

1. Open PowerShell and run the install command. (Exact command pending.)

2. Add the install directory to your PATH, then restart your terminal.

Verify the installation

Step 2: Authenticate

1. 次のコマンドを実行します。

1. Enter the following when prompted:

Your credentials are saved to ~/.twg/auth.conf and reused each time.

Create a classic API token

TWG CLI requires a classic (unscoped) API token.

1. Go to id.atlassian.com/manage-profile/security/api-tokens.

2. Select Create API token — this is the first option on the page.

3. Use the classic (unscoped) option. Do not select Create API token with scopes.

4. Give the token a label such as twg-cli, then copy the token value.

5. Return to your terminal and paste the token when prompted.

Optional: Connect Bitbucket

During twg login you'll be prompted for a Bitbucket API token if you want your agent to access Bitbucket.

Step 3: Set up agent skills

Skills are files that teach your AI coding agent how to use TWG CLI. Installing them is the final step.

1. 次のコマンドを実行します。

1. Follow the interactive picker to select which agent or agents you want to install skills for.

Skills are installed into your project folder under .agents/skills/twg/. Most agents pick them up automatically.

Works automatically (no extra steps):

• Codex

• CURSOR

• Gemini CLI

• GitHub Copilot

• Rovo Dev

Requires selecting during install:

• Claude Code

• Augment

• Kiro

• OpenCode

That's it

Your setup is complete. Describe what you want to your agent in plain English and it handles the rest.

Example prompts to try:

• "What are my open Jira issues?"

• "Summarise the work I did this week."

• "Create a Confluence page summarising this week's sprint."

To update TWG CLI later:

After updating, re-run twg skills install to pick up updated skill files.