Tracker CLI
Use the ytracker CLI to work with Tracker issues from the terminal.
Installing the CLI and signing in to Tracker
ytracker is a command-line utility for working with Tracker. It lets you create and open issues, work with comments, attachments, and checklists, change issue statuses, and search for issues from the terminal.
To install the CLI on macOS or glibc-based Linux, run:
curl -fsSL https://storage.yandexcloud.net/ytracker-cli/install.sh | sh
The installer adds the utility directory to the PATH variable in your shell configuration file. Open a new terminal window and check the installation:
ytracker --version --json
To install the CLI on Windows x64, run the following command in PowerShell:
irm https://storage.yandexcloud.net/ytracker-cli/install.ps1 | iex
ytracker --version --json
The installer verifies the checksum of the downloaded file. On macOS and Linux, the utility is installed in the ~/.local/bin directory. On Windows, the installer adds the utility directory to your user Path variable. To update the CLI, run the installation command again.
The installer configures PATH for the bash, zsh, and sh shells. For other shells, such as fish, install the CLI with curl -fsSL https://storage.yandexcloud.net/ytracker-cli/install.sh | sh -s -- --no-modify-path and add the ~/.local/bin directory to PATH yourself.
To sign in, you need your organization ID. Copy it from Administration → Organizations. If you do not have access to this page, ask your organization administrator for the ID.
Run the following command and confirm the sign-in on the page opened by the utility:
ytracker auth login --method browser --organization-id <organization_id>
If a browser cannot be opened on this computer, for example, when you work over SSH, or if you sign in with a federated account, specify --method token instead of --method browser. The utility prints a link to the OAuth token page and prompts you to paste an OAuth or IAM token. If you sign in with a federated account, paste an IAM token.
To check the authentication, run:
ytracker whoami --json
Working with issues and the API in the CLI
You can use the CLI to view, search for, create, and update issues. For example:
- View an issue with its comments, attachments, and checklist:
ytracker TEAM-42. - Search for an issue by key or summary:
ytracker issue search --text "login form". - Create an issue:
ytracker issue create --summary "Add validation" --queue TEAM --type task. - Update an issue:
ytracker issue update TEAM-42 --priority critical --assignee <login>. - View the available status transitions:
ytracker issue transition list TEAM-42. - Change the status:
ytracker issue transition execute TEAM-42 <transition_id>. - Add a comment:
ytracker issue comment add TEAM-42 "Validation added".
To see the command groups, run ytracker --help. For help with a command group, specify its name, for example, ytracker issue --help.
Commands for working with issues can be used for automation and do not prompt for input. When output is redirected, the utility writes valid JSON to standard output and diagnostic messages to standard error. To run commands without an interactive sign-in, for example, in CI, pass an OAuth token in the TRACKER_TOKEN environment variable or an IAM token in TRACKER_IAM_TOKEN, and the organization ID in TRACKER_ORGANIZATION_ID.
To check a command before modifying data, add the --dry-run parameter to it. The utility prints the HTTP request plan without sending the requests.
You can store default values for new issues in the .tracker.toml file in the current directory or any parent directory, for example, in the repository root. The version = 1 line is required in the file:
version = 1
[create]
queue = "TEAM"
type = "task"
By default, the CLI checks the Access for AI tools option in the queue settings. If it is set to Deny, the CLI does not show or modify issues in this queue, even if you can access them in the web interface. The CLI can still create issues in this queue and add comments, attachments, and checklist items to them. If you work with the CLI without an AI assistant, disable the check with the --ai-access-check=off parameter or the ytracker config set ai-access-check off command.
To send a direct request to the Tracker API, use the ytracker api command. For a direct request, the CLI cannot check access for AI tools, so the command works only when the check is disabled. Specify the path relative to https://api.tracker.yandex.net/v3/. For example:
ytracker --ai-access-check=off api GET issues/TEAM-42
The ytracker api command uses the same authentication as other commands and prints JSON with the status, headers, and body fields.