Conversation
Vex-Session: session-ad7ddb262a78682dcf732e38
|
Read the agent transcripts for this pull request on Composal → https://composal.ai/obsession/chkit/pulls/210/transcripts The plugin-page-only approach was not sufficient for the requested CLI documentation, so ingest now has a dedicated CLI reference page rather than relying on an indirect link. Skills used
|
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: d4e351ac18
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| ### Prerequisites | ||
|
|
||
| The ingest plugin must be registered in `plugins` and the config must set `entry` to a module that exports at least one `definePipeline(...)` value. Without an exported pipeline, every subcommand fails with exit code 2. |
There was a problem hiding this comment.
The entry requirement excludes a supported configuration: resolveConfig maps either entry or legacy schema globs into config.schema (packages/core/src/model.ts:56-65), and loadGraph deliberately imports every module from that array (packages/plugin-ingest/src/plugin.ts:219-223). A project whose schema file exports a pipeline can therefore use all three commands without setting entry; describing entry as mandatory may cause users to perform an unnecessary, potentially disruptive config migration.
Useful? React with 👍 / 👎.
|
|
||
| ### `status` | ||
|
|
||
| Reads the journal and prints the committed checkpoint of each selected stream's scheduled namespace. Streams that have never committed progress show `(no checkpoint)`. |
There was a problem hiding this comment.
For a target where the ingestion journal does not yet exist, status is not only a read: it calls journal.ensure() before querying, and that method executes CREATE TABLE IF NOT EXISTS (packages/plugin-ingest/src/plugin.ts:138-146, packages/plugin-ingest/src/journal.ts:57-60). A direct ClickHouse connection with only SELECT privileges can therefore fail, so the reference should state that status needs permission to create the journal rather than presenting it solely as reading checkpoints.
Useful? React with 👍 / 👎.
| |------|---------| | ||
| | 0 | Success. For `run`, every selected stream succeeded | | ||
| | 1 | Error, or a `run` with any stream that did not succeed | | ||
| | 2 | Configuration error: no exported pipeline, no matching stream, invalid flags, or missing direct connection | |
There was a problem hiding this comment.
For an unknown flag or a missing flag value, such as chkit ingest run --bogus or chkit ingest run --from, direct dispatch catches UnknownFlagError/MissingFlagValueError and explicitly sets exit code 1 (packages/cli/src/runtime/command-dispatch.ts:137-150); the chkit plugin ingest ... forwarder likewise returns 1 (packages/cli/src/commands/plugin.ts:115-127). Only semantic validation performed inside the ingest command, such as an invalid timestamp, returns 2, so grouping all invalid flags under code 2 can make automation handle CLI usage errors incorrectly.
Useful? React with 👍 / 👎.
This branch has not been deployed
1 participant
Summary
cli/ingest.mdcoveringrun,list, andstatus: flags, stream selection, backfills, exit codes, and JSON output, derived frompackages/plugin-ingest/src/plugin.ts.chkit ingestrow at the new page (it previously linked to the plugin page's Commands section) and cross-link it from the Ingest plugin page.chkit pluginto sidebar order 12 sochkit ingestsits before it.Docs-only; no changeset.
Test plan
turbo run typecheck lint build --filter=./apps/docspasses; 48 raw pages,cli/ingest.mdlisted inllms.txt