Compatibility
Build requirements and upstream API compatibility
Checked 2026-09-06. These are documentation and local-test baselines, not certification against every server deployment.
Build requirements
- Go 1.27 or later; this checkout selects Go 1.27.2 using
toolchainincli-go/go.mod. - Go 1.27 builds for macOS require macOS 13 or later. See the Go 1.27 release notes.
- Docs: Node.js 24 or later and pnpm 12.11.2. Install with
pnpm install --frozen-lockfileinweb/. - YAML uses the maintained YAML organization v3 implementation, preserving the v3 configuration API.
Upstream API baseline
Cloud commands use the Jira REST API v3. Issue search uses the enhanced search/jql API with nextPageToken pagination and an explicit field list. Cloud's old /rest/api/3/search endpoint is not the supported search route.
Server/Data Center mode (--api-version 2) retains classic search with startAt pagination. Cloud and Data Center contracts are distinct; do not switch API versions merely to work around a permissions error. Agile commands use the separate /rest/agile/1.0 API.
On Server/Data Center, users are identified by username (id:<username>) instead of accountId, rich text is sent as Jira wiki markup, and --markdown is rejected. These commands use Data Center endpoints instead: filter favourite|unfavourite and filter update --favourite (through /rest/api/1.0/filters/{id}/favourite), group list (the group picker, which Jira caps at jira.ajax.autocomplete.limit, 20 by default), dashboard search (pages through every dashboard and matches names locally), issuetype list --project (the project's issue types), issue changelog (the issue read with expand=changelog), project archive|restore (needs a Data Center license), and user list (/rest/api/2/user/list, in Data Center 11.0 and recent 10.3 LTS releases; on older versions use user search). These are Cloud only and fail before sending any request: filter list|search, group members --group-id, label list, jql parse, permission permitted-projects, webhook (Server/DC webhooks are admin settings under Administration > System > WebHooks), user bulk, and project delete --enable-undo. issue download only follows an attachment content URL on the configured site's origin, so set --site to Jira's base URL.
Maintaining this baseline
Dependabot is configured to propose weekly Go, npm, and GitHub Actions updates. Review migrations before merging; CI verifies the Go tests, race checks, security/static analysis, command documentation, and docs build.
Run go list -m -u all from cli-go/ and pnpm outdated from web/ to check newer releases. Commit go.mod with go.sum, and package.json with pnpm-lock.yaml. Keep fumadocs-core and the fumadocs-ui alias to @fumadocs/base-ui on matching versions.
The website's static search uses Fumadocs' default search engine. After building, run pnpm test:search to verify that the exported index can be loaded and queried by the installed client.