Nick Vigilante
58de9ab8f8
## Summary Corrects broken CLI commands and flags surfaced by the DOCS-637 full-corpus runtime drift sweep. Each fix was verified against the generated CLI reference (`docs/reference/cli/*`) and, where relevant, `codersdk` source. ## Changes | Page | Fix | |------|-----| | `docs/user-guides/workspace-access/index.md` | `coder port forward` → `coder port-forward` (the space form is unrecognized; the command is hyphenated). | | `docs/ai-coder/github-to-tasks.md` | Remove `coder templates list --org your-org-name` in two spots — `templates list` has no `--org` flag (`unknown flag: --org`). | | `docs/admin/infrastructure/scale-utility.md` | `--cleanup-timeout 15min` → `15m` — Go durations reject the `min` unit (`invalid duration: unknown unit "min"`). | | `docs/admin/integrations/dx-data-cloud.md` | `coder users list > users.csv` emitted a whitespace table, not CSV. Emit JSON and convert to real CSV with `jq`, mirroring the API tab on the same page and using the same columns as the default table view (`username,email,created_at,status`). | ## Notes / judgment calls - **dx-data-cloud (CSV):** the page genuinely needs CSV (the DX CSM imports a CSV, and the API tab already produces one via `jq ... @csv`). `coder users list` only supports `--output table|json`, so the CLI tab now produces real CSV via `jq` rather than switching the page to JSON. - **scale-utility `:109` left as-is:** `--target-users 0:100` is prefixed with "For dashboard traffic:", which correctly scopes it to the `scaletest dashboard` subcommand, so it is not drift. - **Excluded — sessions-tokens `--lifetime=720h`:** the sweep flagged this because the throwaway SUT capped token lifetime at 168h, but `--max-token-lifetime` defaults to `876600h` (~100 years), so the example is valid on a default deployment. The `CODER_MAX_TOKEN_LIFETIME` dependency is also already documented in the page's "Set max token length" section. No change needed. Linear: https://linear.app/codercom/issue/DOCS-641 > This PR was created with AI assistance (Coder Agents).
3.2 KiB
DX
DX is a developer intelligence platform used by engineering leaders and platform engineers.
DX uses metadata attributes to assign information to individual users.
While it's common to segment users by role, level, or geo, it’s become increasingly
common to use DX attributes to better understand usage and adoption of tools.
You can create a Coder attribute in DX to segment and analyze the impact of Coder usage on a developer’s work, including:
- Understanding the needs of power users or low Coder usage across the org
- Correlate Coder usage with qualitative and quantitative engineering metrics, such as PR throughput, deployment frequency, deep work, dev environment toil, and more.
- Personalize user experiences
Requirements
- A DX subscription
- Access to Coder user data through the Coder CLI, Coder API, an IdP, or an existing Coder-DX integration
- Coordination with your DX Customer Success Manager
Extract Your Coder User List
You can use the Coder CLI, Coder API, or your Identity Provider (IdP) to extract your list of users.
If your organization already uses the Coder-DX integration, you can find a list of active Coder users directly within DX.
CLI
Use users list with jq to export the list of users to a CSV file:
coder users list --output json | \
jq -r '["username","email","created_at","status"], (.[] | [.username, .email, .created_at, .status]) | @csv' > users.csv
Visit the users list documentation for more options.
API
Use get users:
curl -X GET http://coder-server:8080/api/v2/users \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
To export the results to a CSV file, you can use the jq tool to process the JSON response:
curl -X GET http://coder-server:8080/api/v2/users \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY' | \
jq -r '.users | (map(keys) | add | unique) as $cols | $cols, (.[] | [.[$cols[]]] | @csv)' > users.csv
Visit the get users documentation for more options.
IdP
If your organization uses a centralized IdP to manage user accounts, you can extract user data directly from your IdP.
This is particularly useful if you need additional user attributes managed within your IdP.
Contact your DX Customer Success Manager
Provide the file to your dedicated DX Customer Success Manager (CSM).
Your CSM will import the CSV of individuals using Coder, as well as usage frequency (if applicable) into DX to create a Coder attribute.
After the attribute is uploaded, you'll have a Coder filter option within your DX reports allowing you to:
- Perform cohort analysis (Coder user vs non-user)
- Understand unique behaviors and patterns across your Coder users
- Run a study or setup a PlatformX event for deeper analysis