YouTrack CLI Documentation
YouTrack CLI is a command-line interface for JetBrains YouTrack issue tracking system. It provides an ergonomic way to interact with YouTrack from the terminal, featuring rich text output and a comprehensive set of commands for managing issues, projects, users, and more.
Contents:
- Installation
- YouTrack Concepts
- Quick Start Guide
- Configuration
- Command Aliases
- Security Features
- Logging and Debugging
- Learning Path Guide
- Workflow Examples
- Troubleshooting
- Command Reference
- Issues Command Group
- Articles Command Group
- Projects Command Group
- Users Command Group
- Time Tracking Command Group
- Boards Command Group
- Reports Command Group
- Authentication Command Group
- Configuration Command Group
- Administrative Command Group
- Global Options
- Command Categories
- Common Patterns
- Examples
- API Reference
- Development
Features
Issue Management: Create, update, search, and manage issues with full CRUD operations
Project Management: List, create, and configure projects
User Management: Manage users and permissions
Time Tracking: Log work time and generate reports
Agile Boards: View and manage agile boards
Knowledge Base: Manage YouTrack articles and documentation
Security Features: Command audit logging, credential encryption, and token management
Rich CLI Interface: Beautiful terminal output with rich text formatting
Command Aliases: Short aliases for frequently used commands to improve efficiency
Flexible Configuration: Multiple authentication methods and configuration options
Quick Start
Install YouTrack CLI using pip:
pip install youtrack-cli
Authenticate with your YouTrack instance:
yt auth login
List your issues:
yt issues list
Create a new issue:
yt issues create PROJECT-ID "Bug report" --description "Description here"
Command Categories
Issues Command Group - Issue management commands
Articles Command Group - Knowledge base article management
Projects Command Group - Project management commands
Users Command Group - User management commands
Time Tracking Command Group - Time tracking operations
Boards Command Group - Agile board operations
Reports Command Group - Report generation
Authentication Command Group - Authentication management
Configuration Command Group - Configuration management
Administrative Command Group - Administrative operations