When should I use "CLI Info"?

Use this page when you are implementing cli info in the CLI area of your bot architecture.

What should I read after "CLI Info"?

Continue with related CLI pages to connect this concept with practical implementation details.

CLI Info

Detailed guide for the diagnostic command spraxium info. Learn when to use human-readable output or JSON in troubleshooting workflows.

When to use

Use spraxium info whenever you need a fast diagnostic snapshot of the current machine and project. It is especially useful before opening issues, after upgrades, when CI behaves differently from local development, or when you need to confirm exactly which Spraxium packages a project is running.

terminal

spraxium info
spraxium info --json

If you only need a quick human check, the default terminal output is enough. If the output is going into a ticket, script, or CI artifact, prefer the JSON mode so the full report can be copied and parsed without losing detail.

What the report includes

The command builds a report with the CLI version, detected project name, Node version, operating system, and runtime path. It also captures the preferred package manager and the detected versions of npm, pnpm, yarn, and bun. Finally it scans the project and workspace for all installed @spraxium/* packages and lists each version.

That combination matters because most troubleshooting questions start with one of these unknowns:

Which CLI version is actually running?
Is the machine using the expected Node runtime?
Is the project on the package manager the team expects?
Are framework packages aligned, or is one package lagging behind the others?

spraxium info answers those questions in one pass instead of forcing you to gather them manually.

How to read the report

Check runtime first

Start with Node version, OS, and runtime path. If one machine fails and another succeeds, this is usually the fastest place to spot an environment mismatch.

Check package manager next

Confirm whether the project is using pnpm, npm, yarn, or bun. Dependency resolution issues and lockfile drift often start here.

Check Spraxium package alignment

Compare the discovered @spraxium/ package versions. Mixed versions are a common source of confusing framework behavior after partial upgrades.

Output modes

Prefer JSON when sharing diagnostics

The default output is easier to read in a terminal. The JSON output is better when the report will be pasted into an issue, stored in CI, or compared across machines.

Where and who should use it

Internal support: request minimum context from reporters.
Public bug reports: attach diagnostics in issue templates.
CI debugging: persist report as build artifact.

Advanced users also benefit from it after dependency upgrades. If a workspace suddenly behaves differently after bumping packages, spraxium info is the fastest way to confirm whether the resolved versions match what you intended to install.

Quick issue template

snippet.txt

Problem summary:
Reproduction steps:
Expected result:
Actual result:
Output from `spraxium info --json`:

Practical habit

If your team supports multiple bots or environments, make spraxium info --json part of the default bug-report template. That small habit removes a lot of back-and-forth before real debugging can even begin.