Document CLI dataset commands#141
Merged
Merged
Conversation
Contributor
📝 WalkthroughWalkthroughThis PR adds a new "CLI dataset commands" section to the README documenting how to use the 🚥 Pre-merge checks | ✅ 4✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
README.md (1)
165-165: 💤 Low valueConsider more readable cadence value formatting.
The pipe-separated cadence values
manual\|30m\|6h\|12h\|daily\|weeklyare technically correct but could be formatted for better readability. Consider alternatives:
manual, 30m, 6h, 12h, daily, weeklymanual | 30m | 6h | 12h | daily | weekly(with spaces)🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` at line 165, Replace the compact pipe-escaped cadence token `--cadence manual\|30m\|6h\|12h\|daily\|weekly` with a more readable list in the README table cell for the cadence option; e.g., `--cadence manual, 30m, 6h, 12h, daily, weekly` or `--cadence manual | 30m | 6h | 12h | daily | weekly` (with spaces) so the available values are easier to scan, updating the table row that contains the `--cadence` example accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 137-142: The README currently shows using the --json flag with the
rows command but the "Useful create flags" table only documents create-related
flags; update the documentation to avoid confusion by either renaming that table
header to clarify it only covers create (e.g., "Useful create flags") or,
preferably, expand the flags table to include command-scoped flags such as
--json (used by rows and export) and list any other global or command-specific
flags; locate references to rows and export and add an entry for --json
(describe its effect) or change the table title accordingly so the scope is
clear.
---
Nitpick comments:
In `@README.md`:
- Line 165: Replace the compact pipe-escaped cadence token `--cadence
manual\|30m\|6h\|12h\|daily\|weekly` with a more readable list in the README
table cell for the cadence option; e.g., `--cadence manual, 30m, 6h, 12h, daily,
weekly` or `--cadence manual | 30m | 6h | 12h | daily | weekly` (with spaces) so
the available values are easier to scan, updating the table row that contains
the `--cadence` example accordingly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Comment on lines
+137
to
+142
| Inspect an existing dataset: | ||
|
|
||
| ```bash | ||
| bigset status <datasetId> | ||
| bigset rows <datasetId> --json | ||
| ``` |
Contributor
There was a problem hiding this comment.
Document the --json flag or clarify flag table scope.
Line 141 uses --json with the rows command, but this flag is not documented in the "Useful create flags" table below (lines 158-166). Consider either:
- Expanding the flags table to cover all commands and include
--jsonforrowsandexport, or - Renaming the table to clarify it only documents
createcommand flags
📝 Option 1: Expand the table to document flags for all commands
Replace the table at lines 157-166 with:
-Useful create flags:
+Useful CLI flags:
| Flag | What it does |
|------|-------------|
| `--rows <n>` | Maximum rows to collect |
| `--wait` | Keep the command open until population finishes |
| `--csv <path>` | Write populated rows to a CSV file |
+| `--json` | Output results as JSON (works with `rows` command) |
| `--skip-populate` | Create the dataset without starting population |
| `--cadence manual\|30m\|6h\|12h\|daily\|weekly` | Set refresh cadence |
| `--backend-port <port>` | Target a non-default local backend port |🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 137 - 142, The README currently shows using the
--json flag with the rows command but the "Useful create flags" table only
documents create-related flags; update the documentation to avoid confusion by
either renaming that table header to clarify it only covers create (e.g.,
"Useful create flags") or, preferably, expand the flags table to include
command-scoped flags such as --json (used by rows and export) and list any other
global or command-specific flags; locate references to rows and export and add
an entry for --json (describe its effect) or change the table title accordingly
so the scope is clear.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Verification