Command Reference

YouTrack CLI provides a comprehensive set of commands for managing your YouTrack instance. All commands follow a consistent structure and support common options.

• Issues Command Group
  • Overview
  • Base Command
  • Issue Management Commands
  • Comment Management
  • Attachment Management
  • Issue Relationships
  • Batch Operations
  • Authentication
  • Error Handling
  • Best Practices
  • Advanced Usage
  • See Also
• Articles Command Group
  • Overview
  • Base Command
  • Article Management Commands
  • Article Listing and Discovery
  • Tag Management
  • Comment Management
  • Attachment Management
  • Article Features
  • Common Workflows
  • Best Practices
  • Error Handling
  • See Also
• Projects Command Group
  • Overview
  • Base Command
  • Project Management Commands
  • Project Features
  • Custom Fields Management
  • Common Workflows
  • Best Practices
  • Project Templates
  • Output Formats
  • Error Handling
  • Integration Examples
  • See Also
• Users Command Group
  • Overview
  • Base Command
  • User Management Commands
  • User Management Features
  • User Account States
  • Common Workflows
  • Best Practices
  • Security Considerations
  • Output Formats
  • Error Handling
  • Integration Examples
  • See Also
• Time Tracking Command Group
  • Overview
  • Base Command
  • Time Tracking Commands
  • Duration Formats
  • Date Formats
  • Work Types
  • Common Workflows
  • Best Practices
  • Reporting and Analytics
  • Output Formats
  • Error Handling
  • Performance Optimization
  • See Also
• Boards Command Group
  • Overview
  • Base Command
  • Board Management Commands
  • Board Features and Concepts
  • Common Workflows
  • Best Practices
  • Board Reporting and Analytics
  • Output Formats
  • Error Handling
  • Integration Examples
  • Use Cases
  • Limitations
  • See Also
• Reports Command Group
  • Overview
  • Base Command
  • Report Types
  • Report Features and Concepts
  • Report Output and Visualization
  • Common Workflows
  • Best Practices
  • Report Analysis Guidelines
  • Performance Metrics
  • Error Handling
  • Integration and Automation
  • Limitations
  • Future Enhancements
  • See Also
• Authentication Command Group
  • Overview
  • Base Command
  • Authentication Commands
  • Authentication Process
  • Security Features
  • Common Workflows
  • Troubleshooting Authentication
  • Error Handling
  • Configuration Files
  • Security Best Practices
  • Automation and CI/CD
  • Integration Examples
  • See Also
• Configuration Command Group
  • Overview
  • Base Command
  • Configuration Commands
  • Common Configuration Keys
  • Configuration Examples
  • Environment-Specific Configuration
  • Configuration Workflows
  • Best Practices
  • Configuration File Management
  • Advanced Configuration
  • Error Handling
  • Integration Examples
  • See Also
• Administrative Command Group
  • Overview
  • Base Command
  • Global Settings Management
  • License Management
  • System Maintenance
  • System Health Monitoring
  • User Groups Management
  • Custom Fields Management
  • Administrative Features
  • Common Administrative Workflows
  • Best Practices
  • Security Considerations
  • Troubleshooting
  • Integration Examples
  • Limitations
  • See Also

Global Options

These options are available for all commands:

Option	Type	Description
--help, -h	flag	Show help message and exit
--verbose, -v	flag	Enable verbose output
--quiet, -q	flag	Suppress all output except errors
--config	path	Path to configuration file
--format	choice	Output format: table, json, yaml (default: table)
--no-color	flag	Disable colored output
--dry-run	flag	Show what would be done without making changes

Command Categories

Issue Management

The Issues Command Group command group provides comprehensive issue management capabilities:

• Create, update, and delete issues

• Search and filter issues

• Manage issue comments and attachments

• Handle issue relationships and links

• Assign issues and manage workflow states

Knowledge Base

The Articles Command Group command group manages YouTrack’s knowledge base:

• Create and edit articles

• Manage article hierarchy and organization

• Handle article comments and attachments

• Control article publishing and drafts

Project Management

The Projects Command Group command group handles project administration:

• List and create projects

• Configure project settings

• Manage project permissions

• Archive and restore projects

User Management

The Users Command Group command group provides user administration:

• List and create users

• Update user information

• Manage user permissions and groups

• Handle user authentication settings

Time Tracking

The Time Tracking Command Group command group handles time tracking operations:

• Log work time on issues

• Generate time reports

• View time summaries and statistics

• Export time data

Agile Boards

The Boards Command Group command group manages agile boards:

• List available boards

• View board configurations

• Update board settings

• Manage board columns and swimlanes

Reporting

The Reports Command Group command group generates various reports:

• Burndown charts

• Velocity reports

• Custom report generation

• Export capabilities

Authentication

The Authentication Command Group command group handles authentication:

• Login and logout operations

• Token management

• Authentication testing

• Session management

Configuration

The Configuration Command Group command group manages CLI configuration:

• View and set configuration options

• Manage connection settings

• Handle default values

• Export and import configurations

Administration

The Administrative Command Group command group provides administrative functions:

• System settings management

• User and group administration

• Workflow and field management

• System maintenance operations

Common Patterns

Filtering and Searching

Most list commands support filtering and searching:

yt issues list --assignee me --state open
yt issues search --query "project:PROJECT and state:open"

Output Formatting

All commands support multiple output formats:

yt issues list --format json
yt projects list --format yaml
yt users list --format table

Batch Operations

Many commands support batch operations:

yt issues update ISSUE-1 ISSUE-2 ISSUE-3 --state "Fixed"
yt users create --from-file users.csv

Interactive Mode

Some commands provide interactive prompts:

yt issues create --interactive
yt projects configure PROJECT-ID --interactive

Examples

Common command combinations and workflows:

# Daily workflow
yt issues list --assignee me --state open
yt issues update ISSUE-123 --state "In Progress"
yt time log ISSUE-123 --duration "2h" --description "Fixed bug"

# Project setup
yt projects create --name "New Project" --key "NP"
yt users create --username "john.doe" --email "john@example.com"
yt projects configure NP --add-user "john.doe"

# Reporting
yt time report --project "PROJECT-ID" --from "2024-01-01"
yt reports generate burndown --project "PROJECT-ID" --sprint "Sprint-1"