Skip to content

docs(cli): add import section (arcctl PR4 surface)#9

Merged
xe-nvdk merged 1 commit into
mainfrom
feat/arcctl-pr4-docs
Jun 4, 2026
Merged

docs(cli): add import section (arcctl PR4 surface)#9
xe-nvdk merged 1 commit into
mainfrom
feat/arcctl-pr4-docs

Conversation

@xe-nvdk

@xe-nvdk xe-nvdk commented Jun 1, 2026

Copy link
Copy Markdown
Member

Summary

  • Adds `docs/cli/import.md` covering arcctl's four bulk-import subcommands (csv, lp, parquet, tle).
  • Per-format option tables + examples; common shape (admin-only, multipart, streamed); error catalog; exit codes; database precedence rule.
  • Updates `cli/index.md` status table (PR4 → shipped) and Next list (links to the new import page).
  • Notes the msgpack-scope deviation: server has no `/api/v1/import/msgpack` endpoint, so TLE replaces it; msgpack-write becomes a separate follow-up (PR7).

Companion code PR

Test plan

  • `npm run build` succeeds locally (no new broken links / anchors introduced)
  • Sidebar autogenerates via `sidebar_position: 7` on the new page
  • All inter-page links use absolute `/arc/cli/...` paths (matches PR2/PR3 docs convention)

🤖 Generated with Claude Code

Companion docs for arcctl PR4 (Basekick-Labs/arcctl#3)
which adds `arcctl import {csv,lp,parquet,tle}`.

New page
- docs/cli/import.md — common shape (admin-only, multipart, streamed
                       via io.Pipe), per-format options + examples
                       (CSV time-column/format/delimiter/skip-rows,
                       LP precision + gzip auto-detection + filter
                       semantic, Parquet time-column, TLE measurement-
                       via-header + checksum behavior + parse_warnings),
                       output formats, database precedence, auth
                       (admin token required; 403 surfaces verbatim),
                       common errors, exit codes

Index update
- docs/cli/index.md   — status table flips PR4 → shipped, Next list
                        adds the import link. msgpack write follow-up
                        noted for v0.5.0+.

The plan originally listed msgpack as the 4th import format; the Arc
server has no /api/v1/import/msgpack endpoint, so TLE replaces it
here and msgpack-write becomes a separate follow-up (PR7 in the
arcctl roadmap).

Build verified locally with `npm run build` — no new broken links
or anchors introduced.
@xe-nvdk xe-nvdk merged commit 5deafef into main Jun 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant