Skip to content

Conversation

stefanlegg
Copy link

@stefanlegg stefanlegg commented Aug 29, 2025

This PR corrects the installation script path in documentation to point to the correct location in the repository.

Changes:

  • Updated ccpm.sh path from main/ccpm.sh to main/install/ccpm.sh in main README.md installation instructions
  • Updated ccpm.bat path from main/ccpm.bat to main/install/ccpm.bat in main README.md installation instructions
  • Updated corresponding paths in install/README.md for both curl and wget commands

The install script was moved to the install/ directory but the documentation still referenced the old root location, causing 404 errors for users trying to install via the provided commands.

Summary by CodeRabbit

  • Documentation
    • Updated installation commands to point to the installer in the repo's install directory for Unix/Linux/macOS (curl/wget) and for Windows PowerShell.
    • Aligned instructions across docs for consistency and reduced setup friction for shell- and PowerShell-based installs.

Copy link

coderabbitai bot commented Aug 29, 2025

Walkthrough

Updated documentation changes download URLs in README files to reference install/ccpm.sh and install/ccpm.bat inside the install directory instead of scripts at the repository root. No code, API, or exported/public entity changes.

Changes

Cohort / File(s) Change Summary
Docs: installer script path updates
README.md, install/README.md
Replaced references to root-level ccpm.sh/ccpm.bat with install/ccpm.sh and install/ccpm.bat in curl/wget/PowerShell one-liners and related download instructions; documentation-only edits, no public API changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

I twitch my whiskers at a gentler map,
From root to install I tighten the gap.
Curl, wget, PowerShell all hop in line,
Scripts relocated — the burrow's fine.
A little hop, a tidy trail; hooray! 🐇✨

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.


📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 3bff66d and f48ed35.

📒 Files selected for processing (2)
  • README.md (1 hunks)
  • install/README.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • README.md
  • install/README.md
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbit in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbit in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbit gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbit read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbit help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbit ignore or @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbit summary or @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbit or @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@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 (4)
install/README.md (2)

6-13: Harden one-liners: fail-fast on HTTP errors and pipeline failures.

  • Add -f to curl so 404/5xx don’t get piped to bash.
  • Prefer curl variant, or wrap wget with pipefail to avoid false success when wget fails.

Apply:

-curl -sSL https://raw.githubusercontent.com/automazeio/ccpm/main/install/ccpm.sh | bash
+curl -fsSL https://raw.githubusercontent.com/automazeio/ccpm/main/install/ccpm.sh | bash

Optional (if keeping wget):

-wget -qO- https://raw.githubusercontent.com/automazeio/ccpm/main/install/ccpm.sh | bash
+# Less preferred: ensure pipeline fails if wget fails
+bash -c 'set -o pipefail; wget -qO- https://raw.githubusercontent.com/automazeio/ccpm/main/install/ccpm.sh | bash'

15-25: Consider pinning installs to a tag for reproducibility.

Document an alternative that references a released tag instead of main to avoid drift.

Example:

curl -fsSL https://raw.githubusercontent.com/automazeio/ccpm/vX.Y.Z/install/ccpm.sh | bash
README.md (2)

391-393: Path update is correct; mirror curl hardening.

Approve the install/ccpm.sh path. Also add -f to curl (and same note about wget/pipefail if you show wget elsewhere) to fail fast on HTTP errors.

Apply:

-   curl -sSL https://raw.githubusercontent.com/automazeio/ccpm/main/install/ccpm.sh | bash
+   curl -fsSL https://raw.githubusercontent.com/automazeio/ccpm/main/install/ccpm.sh | bash
-   # or: wget -qO- https://raw.githubusercontent.com/automazeio/ccpm/main/install/ccpm.sh | bash
+   # or (ensure pipeline fails if download fails):
+   # bash -c 'set -o pipefail; wget -qO- https://raw.githubusercontent.com/automazeio/ccpm/main/install/ccpm.sh | bash'

395-403: Optional: add pinned-tag variant and checksum note.

For deterministic installs, show a tag-pinned command and (optionally) a shasum verify step.

Example:

# Pin to a release tag
curl -fsSL https://raw.githubusercontent.com/automazeio/ccpm/vX.Y.Z/install/ccpm.sh | bash

# Optional integrity check
# curl -fsSL https://github.com/automazeio/ccpm/releases/download/vX.Y.Z/ccpm.sh.sha256 -o ccpm.sh.sha256
# curl -fsSL https://raw.githubusercontent.com/automazeio/ccpm/vX.Y.Z/install/ccpm.sh -o ccpm.sh
# shasum -a 256 -c ccpm.sh.sha256 && bash ccpm.sh
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between d01e80a and 3bff66d.

📒 Files selected for processing (2)
  • README.md (1 hunks)
  • install/README.md (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2025-08-28T00:16:38.208Z
Learnt from: gsornsen
PR: automazeio/ccpm#545
File: .github/workflows/release-test.yml:54-65
Timestamp: 2025-08-28T00:16:38.208Z
Learning: In gsornsen's CCPM project, the GitHub Actions workflows deliberately install Git Bash and Chocolatey on Windows runners to normalize shell commands across all platforms (Windows, macOS, Linux), creating a unified bash environment that works consistently across the OS matrix.

Applied to files:

  • README.md
  • install/README.md
📚 Learning: 2025-08-28T00:18:18.000Z
Learnt from: gsornsen
PR: automazeio/ccpm#545
File: Makefile:175-175
Timestamp: 2025-08-28T00:18:18.000Z
Learning: In gsornsen's CCPM project, they prefer to ignore native Windows cmd.exe compatibility issues (like mkdir -p) in favor of their Git Bash approach that normalizes shell commands across all platforms, creating a unified bash environment.

Applied to files:

  • README.md
🔇 Additional comments (1)
install/README.md (1)

6-6: Path fix is correct.

install/ccpm.sh is the right target after the move. Looks good.

Also applies to: 12-12

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