LinuxCommandLibrary

jira-projects

TLDR

View documentation for the original command

$ tldr jira project
copy

SYNOPSIS

jira-projects [-s SERVER] [-u USER] [-t TOKEN] [-p PROJECT] [--json] [--plain]

PARAMETERS

-s, --server=URL
    Jira base URL (e.g., https://your-domain.atlassian.net)

-u, --user=USER
    Jira username or email

-t, --token=TOKEN
    API token or password for auth

-p, --project=KEY
    Filter by exact project key or name

-T, --type=TYPE
    Filter by project type (e.g., software, business)

--json
    Output in JSON format for parsing

--plain
    Plain text output without table formatting

--max-results=N
    Limit results (default: 50)

-h, --help
    Show help

DESCRIPTION

The jira-projects command is a utility from the Jira CLI toolkit, designed to query and display projects from an Atlassian Jira instance directly from the Linux terminal. It authenticates with the Jira server using API tokens or basic auth, retrieves project details via the REST API, and formats output as a readable table or JSON. Ideal for scripting, CI/CD pipelines, or quick checks without a web browser.

Users configure it via environment variables (JIRA_BASE_URL, JIRA_USER, JIRA_API_TOKEN) or command-line flags. It supports filtering by project keys, names, or types (e.g., software, service), and pagination for large instances. Output includes key, name, type, lead, and URL. Errors like invalid creds or network issues are reported clearly.

CAVEATS

Requires valid Jira API token (basic auth deprecated).
Network-dependent; fails offline.
Large instances may hit API rate limits.

CONFIGURATION

Set env vars: export JIRA_BASE_URL=https://example.atlassian.net
export JIRA_USER=your@email.com
export JIRA_API_TOKEN=yourtoken for default usage.

EXAMPLE

jira-projects --json | jq '.[] | select(.key=="PROJ")'
Filters and parses JSON output.

HISTORY

Introduced in jira-cli v1.0.0 (2020) by go-jira project; evolved with Jira Cloud/Server API v3 support in v2.x.

SEE ALSO

jira(1), curl(1), jq(1)

Copied to clipboard