Skip to content

Diagnostics

KoukeNeko edited this page Sep 9, 2026 · 4 revisions

Diagnostics

English · 繁體中文

doctor

taiga doctor
taiga doctor --host http://localhost:9000/taiga/
taiga doctor --api-url http://localhost:9000/taiga/api/v1/ --json

Four checks run in order:

Check Contents
frontend API discovery from conf.json (only when --host is given)
api Whether the API is reachable, with round-trip time
authentication Whether the current credential works, and for which user
project Whether the default project exists and is accessible

Without a credential or a selected project, the corresponding entries are marked pending rather than error. No token appears in the output.

--host and --api-url are mutually exclusive.

Shareable diagnostic bundles

taiga doctor bundle ./taiga-diagnostics.zip --json
taiga doctor bundle ./taiga-diagnostics.zip --force

Produces a zip you can paste into an issue without worrying, holding four JSON files:

File Contents
system.json CLI version, commit, build time, Go version, OS, architecture, contract version
config.json Presence booleans and counts (number of profiles, whether a credential exists)
checks.json ok, pending, or error status codes and latencies for API, authentication, project
manifest.json Format version, creation time, and the privacy statement

What it never contains

URLs, hostnames, usernames, project and profile names, the working directory, environment variable values, request or response bodies, raw logs, or any credential.

Before writing, the CLI takes the sensitive values it actually observed during the run — tokens, usernames, project names — and scans the uncompressed bundle contents for them. A hit refuses the write and reports diagnostic_redaction_failed.

Other guarantees

  • The bundle is created locally and is never uploaded automatically.
  • Both the output file and the zip entries use 0600 permissions.
  • An existing file is not overwritten without an explicit --force.
  • manifest.format is currently 1 and evolves independently of the CLI's JSON contract version.

Clone this wiki locally