Skip to content

Maestro discord cli documentation#15

Merged
chr1syy merged 2 commits intoRunMaestro:mainfrom
scriptease:Maestro-Discord-CLI-documentation
Apr 18, 2026
Merged

Maestro discord cli documentation#15
chr1syy merged 2 commits intoRunMaestro:mainfrom
scriptease:Maestro-Discord-CLI-documentation

Conversation

@scriptease
Copy link
Copy Markdown

@scriptease scriptease commented Apr 13, 2026

Added discord cli installation documentation

Summary by CodeRabbit

  • Documentation
    • Added installation instructions for maestro-cli and maestro-discord CLIs.
    • Provided OS-specific setup steps for creating CLI wrappers on macOS, Linux, and Windows.
    • Documented alternative run/install options (direct Node execution and npm link).
    • Clarified that existing prerequisites and quick-start/command guidance remain unchanged.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 13, 2026

Warning

Rate limit exceeded

@scriptease has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 52 minutes and 6 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 52 minutes and 6 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: ad18412e-bdf7-4c8e-adba-5bcc8d55ecb6

📥 Commits

Reviewing files that changed from the base of the PR and between b61071e and 0a7147d.

📒 Files selected for processing (1)
  • README.md
📝 Walkthrough

Walkthrough

Added detailed README prerequisites documenting how to install and expose two CLIs: maestro-cli (Maestro-installed Node script) and maestro-discord (locally built dist/cli/maestro-discord.js), with OS-specific wrapper installation steps for macOS/Linux and Windows, plus direct Node and npm link alternatives.

Changes

Cohort / File(s) Summary
README documentation
README.md
Expanded prerequisites with platform-specific instructions to create CLI wrappers for maestro-cli and maestro-discord: macOS/Linux sudo tee into /usr/local/bin, Windows PowerShell creating .cmd in %USERPROFILE%\bin and PATH guidance; added direct Node.js invocation and npm link alternative.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐇 I hopped through README rows with care,
Crafted wrappers for tools everywhere.
Mac, Linux, Windows—each gets a key,
Run direct or link, and launch with glee.
Cheers to builds and commands set free!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Maestro discord cli documentation' accurately reflects the main change: adding documentation for the Maestro Discord CLI installation and setup instructions in README.md.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@scriptease scriptease force-pushed the Maestro-Discord-CLI-documentation branch from 824534a to 8cb6da7 Compare April 13, 2026 05:43
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
README.md (1)

23-35: Split mixed-shell snippets into shell-specific code fences

bash blocks currently include PowerShell content, which is easy to mis-copy and fail. Consider separate fenced blocks per platform (bash for macOS/Linux, powershell for Windows) for safer copy/paste.

Also applies to: 47-60

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 23 - 35, The README contains mixed-shell code fences:
the bash blocks include macOS/Linux printf lines ('printf ...
/usr/local/bin/maestro-cli') and a Windows PowerShell batch creation block
(Out-File to create maestro-cli.cmd), which can be mis-copied; split these into
separate fenced blocks — use ```bash for the macOS and Linux printf/shebang
snippets (the node "/Applications/Maestro.app/Contents/Resources/maestro-cli.js"
and node "/opt/Maestro/resources/maestro-cli.js" lines) and a separate
```powershell block for the Windows batch snippet that creates maestro-cli.cmd
with Out-File — apply the same separation to the later similar section that
contains the Windows PowerShell content.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Around line 30-35: The Windows PowerShell snippets write .cmd wrappers under
ProgramFiles which is typically not on the user PATH, causing maestro-cli /
maestro-discord to be uncallable; update the README to either write the wrapper
into a directory that is on PATH (e.g., use
$env:ProgramData\Maestro\maestro-cli.cmd or %USERPROFILE%\bin) or add explicit
instructions to add the created ProgramFiles\Maestro folder to PATH, and update
both the maestro-cli and maestro-discord snippets (the .cmd creation lines
shown) so the Out-File target is a PATH-accessible location or document the PATH
export step.

---

Nitpick comments:
In `@README.md`:
- Around line 23-35: The README contains mixed-shell code fences: the bash
blocks include macOS/Linux printf lines ('printf ...
/usr/local/bin/maestro-cli') and a Windows PowerShell batch creation block
(Out-File to create maestro-cli.cmd), which can be mis-copied; split these into
separate fenced blocks — use ```bash for the macOS and Linux printf/shebang
snippets (the node "/Applications/Maestro.app/Contents/Resources/maestro-cli.js"
and node "/opt/Maestro/resources/maestro-cli.js" lines) and a separate
```powershell block for the Windows batch snippet that creates maestro-cli.cmd
with Out-File — apply the same separation to the later similar section that
contains the Windows PowerShell content.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 50bac0c3-59d3-40b5-95a3-29d77fbca3a1

📥 Commits

Reviewing files that changed from the base of the PR and between d79eb3f and 8cb6da7.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md Outdated
@scriptease
Copy link
Copy Markdown
Author

The unit tests fail with missing token

Error: Missing required env var: DISCORD_BOT_TOKEN

at required (/home/runner/work/Maestro-Discord/Maestro-Discord/dist/config.js:13:15)

at Object. (/home/runner/work/Maestro-Discord/Maestro-Discord/dist/config.js:26:12)

at Module._compile (node:internal/modules/cjs/loader:1705:14)

at Object..js (node:internal/modules/cjs/loader:1838:10)

at Module.load (node:internal/modules/cjs/loader:1441:32)

at Function._load (node:internal/modules/cjs/loader:1263:12)

at TracingChannel.traceSync (node:diagnostics_channel:328:14)

at wrapModuleLoad (node:internal/modules/cjs/loader:237:24)

at Module.require (node:internal/modules/cjs/loader:1463:12)

at require (node:internal/modules/helpers:147:16)

Add Linux, Windows, and direct Node.js install instructions for both
maestro-cli and maestro-discord CLIs.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@scriptease scriptease force-pushed the Maestro-Discord-CLI-documentation branch from 5b75579 to b61071e Compare April 18, 2026 12:19
- Remove the inline "Install Maestro CLI" section from the README and
  instead link to https://docs.runmaestro.ai/cli from the Prerequisites
  list, so install instructions live in one canonical place.
- For the remaining maestro-discord install section, write the wrapper
  to %USERPROFILE%\bin (instead of %ProgramFiles%) and idempotently
  add that dir to user PATH so the wrapper is actually callable.
- Split the mixed bash + PowerShell fenced blocks into separate bash
  and powershell blocks to prevent mis-copy and restore highlighting.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@scriptease scriptease force-pushed the Maestro-Discord-CLI-documentation branch from b61071e to 0a7147d Compare April 18, 2026 12:26
@chr1syy chr1syy merged commit ca5fd8d into RunMaestro:main Apr 18, 2026
3 checks passed
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.

3 participants