Skip to content

docs: Update README to match current CLI syntax - #4

Merged
blooop merged 4 commits into
mainfrom
docs/update-readme-cli-syntax
Jan 17, 2026
Merged

blooop merged 4 commits into
mainfrom
docs/update-readme-cli-syntax

Conversation

@blooop

@blooop blooop commented Jan 17, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • Updated README to reflect the current workspace-first CLI syntax (dl <workspace> stop instead of dl --stop <workspace>)
  • Added new commands: restart, prune alias, --version
  • Removed outdated --status command
  • Added documentation maintenance reminder to AGENTS.md

Test plan

  • Verify README examples match dl --help output
  • Confirm all documented commands work as described

🤖 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:

  • Document newly available commands such as restart, prune alias, and --version in the CLI usage section.

Documentation:

  • Update README usage, command tables, and examples to reflect workspace-first CLI commands, new subcommands, and the --version flag.
  • Add a documentation maintenance section to AGENTS.md reminding contributors to update README.md when CLI behavior changes.

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>
@sourcery-ai

sourcery-ai Bot commented Jan 17, 2026 •

Copy link
Copy Markdown

Reviewer's Guide

Updates 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

Change Details Files
Align README usage and command sections with the current workspace-first CLI interface.
  • Adjusted top-level usage examples to show workspace-first patterns, including dl <workspace> <cmd> vs dl <workspace> -- <command> for shell commands.
  • Renamed the generic Commands section to Workspace Commands and documented workspace-scoped subcommands such as stop, rm/prune, code, restart, recreate, reset, and -- <cmd>.
  • Separated and updated Global Commands to reflect only global flags (--ls, --install, --help/-h, --version) and removed outdated workspace flags like --stop, --rm, --code, --status, --recreate, and --reset.
  • Updated examples to use the new workspace-first syntax for VS Code (dl <workspace> code), running commands (dl <workspace> -- <cmd>), and stopping workspaces (dl <workspace> stop).
README.md
Add contributor guidance for keeping CLI documentation accurate.
  • Appended a Documentation Maintenance section instructing contributors to update README.md when CLI commands/flags/usage change and to use pixi run dl --help as the source of truth.
AGENTS.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've left some high level feedback:

  • 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.
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.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov

codecov Bot commented Jan 17, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 65.40%. Comparing base (0484860) to head (1b95c59).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main       #4   +/-   ##
=======================================
  Coverage   65.40%   65.40%           
=======================================
  Files           3        3           
  Lines         422      422           
=======================================
  Hits          276      276           
  Misses        146      146           

Impacted file tree graph

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

blooop and others added 2 commits January 17, 2026 17:08
- 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>
@blooop
blooop merged commit ec3ef38 into main Jan 17, 2026
9 checks passed
@blooop
blooop deleted the docs/update-readme-cli-syntax branch January 17, 2026 17:19
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