hlix status
Reference for hlix status — the resolved workspace and API, the folder binding, and local-versus-cloud drift.
hlix status reports the current folder’s target and synchronization state. It shows the resolved Workspace and API, the source of each setting, the project binding and changes since the last sync.
Run it to check an unfamiliar checkout or investigate an unexpected target.
Prerequisites
Section titled “Prerequisites”Run status in any directory to inspect available configuration, including missing credentials or bindings.
hlix status [--cwd <dir>] [--json]--cwd <dir>(string, default the process working directory): report on another folder, including its binding lookup. A path that is not a directory exitsinvalid_usage— see the validation note below.--json(boolean, defaultfalse): return the structured report instead of the aligned fields. The payload carriescwd,workspace,api,credential,conflict,project,repository,local,cloud, andinstall, each with its ownsourceorerrorwhere one applies.
Expected result:
folder /Users/you/acme-invoicesworkspace org_2p9xk4 (from project)api https://server.hlix.ai (from project)credential file (/Users/you/.config/hlix/credentials.json)project 6f1c2a9e-8f0b-4a7d-9d33-2f0b1c7e5a41HLIX Repos 8a2b6c1d4e9f027a83b5cd6e7f80192a3b4c5d6elocal 412 files, matches the last synccloud commit 8a2b6c1d4e9f027a83b5cd6e7f80192a3b4c5d6e, up to dateWhat each line can say
Section titled “What each line can say”| Line | Values you will see |
|---|---|
workspace |
the ID and its source (flag, env, project, credential), or none — run `hlix auth login --workspace <id>` |
credential |
environment (HLIX_API_KEY), file (<path>), or none — run `hlix auth login` |
project |
the project ID, initialized at <root>, not imported yet, or none — run `hlix import .` to bind this folder |
local |
<n> files, matches the last sync, … modified since the last sync, … no synced base revision, or could not scan: <reason> |
blocking |
present only when the scan found blockers; they are listed inline |
cloud |
commit <sha> available — run `hlix pull` , commit <sha>, up to date, or not checked: <error code> |
conflict |
present only when an override contradicts the folder’s binding |
installed |
this hlix and how it was installed: (Homebrew), (npm), or (installer) |
duplicate |
present only when more than one hlix is installed: which one runs, and the one command that removes the other |
A completed status report exits 0, including when it reports missing configuration, an unreachable API or a target conflict. Invalid command arguments exit 2.
Conflicts and validation
Section titled “Conflicts and validation”- A contradicting
--workspace,--base-url, orHLIX_*value appears on theconflictline rather than aborting the report. Every other command exitsworkspace_mismatchon the same input. - An argument error still exits
2— an unknown flag, a stray positional, or a--cwdthat is not a directory. Those are rejected before the status report starts. - The binding is found by walking up from
--cwd, sohlix statusinpackages/apireports the project, not a fragment of it.
If status reports something unexpected
Section titled “If status reports something unexpected”workspace … (from credential)where you expected(from project)— the folder is not bound. Runhlix import ..cloud not checked: unreachable— the API could not be contacted. Local configuration and scan results remain available.cloud not checked: unauthenticated— the stored credential no longer works against this workspace. Runhlix auth statusfor the probe result.local could not scan: …— the scan itself failed. The message is the scanner’s own; a symlink or an unreadable path is the usual cause.- A
conflictline — drop the override rather than editing thehlix:block inhlix.ymlto match it.