
jira-search-jql
by grandcamel
Claude Code Skills for JIRA automation - modular skills for issue management, workflows, search, and collaboration
SKILL.md
name: "jira-search-jql" description: "Find issues by criteria (status, assignee, priority, etc.) using JQL. Create filters, export results to CSV/JSON, bulk update. Ideal for reporting and automation." version: "1.0.0" author: "jira-assistant-skills" license: "MIT" allowed-tools: ["Bash", "Read", "Glob", "Grep"]
jira-search
Query and discovery operations for JIRA issues using JQL (JIRA Query Language).
Risk Levels
| Operation | Risk | Notes |
|---|---|---|
| Query/search | - | Read-only |
| Validate JQL | - | Read-only |
| Export results | - | Read-only (local file) |
| List filters | - | Read-only |
| Create filter | - | Easily reversible (can delete) |
| Share filter | ! | Can be unshared |
| Delete filter | !! | Filter lost, but can recreate |
Risk Legend: - Safe, read-only | ! Caution, modifiable | !! Warning, destructive but recoverable | !!! Danger, irreversible
When to use this skill
Perfect for:
- Search by criteria: "Find all bugs assigned to me in the current sprint"
- Reporting: Export sprint results or metrics to CSV/JSON
- Bulk operations: Update labels, priority, or assignee on 50+ issues at once
- Automation: Create saved filters for monitoring or dashboards
Not ideal for:
- Single issue operations - Use jira-issue skill
- Workflow transitions on many issues - Use jira-lifecycle skill
- Complex issue relationships - Use jira-relationships skill
- Sprint/board management - Use jira-agile skill
Quick Start
# Find your open issues
jira-as search query "assignee = currentUser() AND status != Done"
# Find bugs in a project
jira-as search query "project = PROJ AND type = Bug AND status = Open"
# Export results to CSV
jira-as search export "project = PROJ" --output report.csv
# Save a filter for reuse
jira-as search filter create "My Bugs" "type = Bug AND assignee = currentUser()" --favourite
For detailed setup, see docs/QUICK_START.md.
Available Commands
IMPORTANT: Always use the jira-as CLI. Never run Python scripts directly.
| Command | Purpose | Example |
|---|---|---|
jira-as search query | Execute JQL queries | jira-as search query "project = PROJ" |
jira-as search export | Export to CSV/JSON | jira-as search export "JQL" -o report.csv |
jira-as search validate | Check JQL syntax | jira-as search validate "your query" |
jira-as search build | Build JQL from options | jira-as search build --project PROJ --status Open |
jira-as search suggest | Get field value suggestions | jira-as search suggest --field status |
jira-as search fields | List available JQL fields | jira-as search fields |
jira-as search functions | List available JQL functions | jira-as search functions |
jira-as search filter list | List saved filters | jira-as search filter list --favourite |
jira-as search filter create | Save a reusable filter | jira-as search filter create "Name" "JQL" |
jira-as search filter run | Run a saved filter | jira-as search filter run 10042 |
jira-as search filter share | Share filter with users/groups | jira-as search filter share 10042 --project PROJ |
jira-as search filter delete | Delete a saved filter | jira-as search filter delete 10042 --force |
All commands support --help for full documentation.
What this skill does
- JQL Search: Execute custom queries with sorting, pagination, field selection
- JQL Builder: Build and validate queries interactively
- Query History: Save queries locally for quick reuse
- Saved Filters: Full CRUD on JIRA filters with sharing
- Filter Subscriptions: View email subscriptions on filters
- Export Results: CSV, JSON, JSON Lines with streaming for large datasets
- Bulk Updates: Update multiple issues from search results
Common Options
| Option | Description |
|---|---|
--help, -h | Show help message and usage |
--output, -o | Output format: text (default), json |
--max-results, -m | Maximum results to return |
--fields | Comma-separated list of fields |
Examples by Category
Search
# Basic search
jira-as search query "project = PROJ AND status = Open"
# With field selection
jira-as search query "project = PROJ" --fields key,summary,status,assignee
# With result limit
jira-as search query "project = PROJ" --max-results 50
JQL Building
# Validate syntax
jira-as search validate "project = PROJ AND status = Open"
# Build JQL from options
jira-as search build --project PROJ --status Open --assignee currentUser()
# Get field suggestions
jira-as search suggest --field status
jira-as search suggest --field status --prefix "In"
jira-as search suggest --field assignee --prefix "john"
# List available fields and operators
jira-as search fields
# List available JQL functions
jira-as search functions
Saved Filters
# Create filter
jira-as search filter create "Sprint Issues" "sprint IN openSprints()" --favourite
# List filters
jira-as search filter list --favourite
# Run filter (by filter ID)
jira-as search filter run 10042
# Share filter
jira-as search filter share 10042 --project PROJ
# Delete filter
jira-as search filter delete 10042 --force
Export
# CSV export
jira-as search export "project = PROJ" -o report.csv
# JSON export
jira-as search export "project = PROJ" -o data.json --format json
# Export specific fields
jira-as search export "project = PROJ" -o report.csv --fields key,summary,status,assignee
# Limit results
jira-as search export "project = PROJ" -o report.csv --max-results 500
Using Filters in Queries
# Run a query using a saved filter ID
jira-as search query --filter 10042
# Combine filter with additional criteria
jira-as search query --filter 10042 --max-results 100
# Save search results as a new filter
jira-as search query "project = PROJ" --save-as "My New Filter"
Exporting Large Datasets
For large exports, optimize your query and field selection:
| Result Size | Recommendation |
|---|---|
| < 1000 | jira-as search export "JQL" -o file.csv |
| 1000-5000 | jira-as search export "JQL" -o file.csv --fields key,summary,status |
| > 5000 | Split by date ranges using created/updated filters |
# Large export with minimal fields for speed
jira-as search export "project = PROJ" -o report.csv --fields key,summary,status,assignee
# Split by time periods for very large datasets
jira-as search export "project = PROJ AND created >= -30d" -o recent.csv
jira-as search export "project = PROJ AND created >= -60d AND created < -30d" -o older.csv
Exit Codes
| Code | Meaning |
|---|---|
| 0 | Success |
| 1 | General error (API, validation) |
| 2 | Invalid arguments |
| 130 | User interrupted (Ctrl+C) |
Troubleshooting
Quick diagnostics:
jira-as search validate "your query" # Check syntax
jira-as search fields # List available fields
jira-as search suggest --field status # Get valid values for a field
jira-as search functions # List available JQL functions
For detailed troubleshooting, see references/TROUBLESHOOTING.md.
Configuration
Requires JIRA credentials via environment variables (JIRA_SITE_URL, JIRA_EMAIL, JIRA_API_TOKEN).
Documentation
| Document | Purpose |
|---|---|
| docs/QUICK_START.md | Get started in 5 minutes |
| references/jql_reference.md | JQL syntax reference |
| references/BEST_PRACTICES.md | Expert guide |
| references/TROUBLESHOOTING.md | Error solutions |
| assets/QUICK_REFERENCE.txt | Printable cheat sheet |
Templates
Pre-configured JQL templates:
assets/templates/jql_templates.json- Common search patternsassets/ERROR_SOLUTIONS.json- Error catalog
Related skills
- jira-issue: For creating and updating individual issues
- jira-lifecycle: For transitioning issues found in searches
- jira-collaborate: For bulk commenting on search results
- jira-agile: For sprint and board operations
- jira-relationships: For issue linking and dependencies
- jira-bulk: For large-scale bulk operations
Score
Total Score
Based on repository quality metrics
SKILL.mdファイルが含まれている
ライセンスが設定されている
100文字以上の説明がある
GitHub Stars 100以上
1ヶ月以内に更新
10回以上フォークされている
オープンIssueが50未満
プログラミング言語が設定されている
1つ以上のタグが設定されている
Reviews
Reviews coming soon
