Repository navigation
docs: Update README to match current CLI syntax - #4
Merged
Merged
Conversation
The README was using outdated flag-based syntax (--stop, --rm, --code, etc.) while the tool now uses workspace subcommands (dl <workspace> stop, etc.). Also adds documentation maintenance reminder to AGENTS.md. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Reviewer's GuideUpdates documentation to match the current workspace-first CLI syntax, splitting workspace vs global commands, adding new commands/flags, removing deprecated ones, updating examples, and adding a maintenance reminder for keeping docs in sync with the CLI help output. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- The examples now mix placeholder-style names (
<workspace>) with concrete ones likeblooop/devlaunchandmyproject; consider standardizing on one convention or clearly separating generic examples from project-specific ones to avoid confusion. - In the workspace commands table, the
prunealias is only mentioned in the description; consider including an explicitdl <workspace> pruneentry or example so users searching forprunesee the exact syntax immediately.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The examples now mix placeholder-style names (`<workspace>`) with concrete ones like `blooop/devlaunch` and `myproject`; consider standardizing on one convention or clearly separating generic examples from project-specific ones to avoid confusion.
- In the workspace commands table, the `prune` alias is only mentioned in the description; consider including an explicit `dl <workspace> prune` entry or example so users searching for `prune` see the exact syntax immediately.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4 +/- ##
=======================================
Coverage 65.40% 65.40%
=======================================
Files 3 3
Lines 422 422
=======================================
Hits 276 276
Misses 146 146 🚀 New features to boost your workflow:
|
- Standardize examples to use consistent naming (`myworkspace`, `user/repo`) - Add explicit `prune` entry to workspace commands table - Fix outdated `--stop` reference in Shell Completion section Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Use <user/repo> pattern instead of <workspace> - Add Workspace Sources section matching help - Use concrete examples (devpod, loft-sh/devpod, blooop/devlaunch) - Match help descriptions exactly Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This was referenced Aug 22, 2026
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
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
dl <workspace> stopinstead ofdl --stop <workspace>)restart,prunealias,--version--statuscommandTest plan
dl --helpoutput🤖 Generated with Claude Code
Summary by Sourcery
Align CLI documentation with the current workspace-first syntax and add guidance for keeping docs in sync with the tool’s help output.
New Features:
Documentation: