docs(readme): Separate docker commands for easier copy & paste

[yamadashy]

Checklist

• Run npm run test
• Run npm run lint

[bolt-new-by-stackblitz]

Run & review this pull request in StackBlitz Codeflow.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request introduces a new section on Docker usage in the README.md file for the Repomix project. This section provides instructions for running Repomix within a Docker container, including commands for basic usage in the current directory and for processing a specific directory or a remote repository. The existing command examples have been reformatted for clarity, and additional context has been added. The overall structure of the README remains consistent, with the Docker section integrated into the existing documentation.

Changes

File	Change Summary
README.md	Added a new section with Docker usage instructions, including commands for running Repomix in a Docker container for local and remote repository processing. Existing command examples reformatted for clarity.

Possibly related PRs

• Add support for Docker #222: Adds a Docker usage section in the README.md, directly related to the current PR's documentation changes.
• ci(docker): Add release permissions to docker workflow #227: Enhances Docker workflow by adding release permissions.
• ci(docker): Add latest tag for v* release tags and modify push events #229: Modifies Docker workflow to include a "latest" tag for versioned releases.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5f80c0a and 145e5af.

📒 Files selected for processing (1)

• README.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• README.md

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai 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:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @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

Documentation and Community

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

README.md (2)

105-109: Enhance Docker command documentation

While the command is correct, it could benefit from additional context and explanation:

1. Explain that /app is the working directory inside the container
2. Clarify where the output file will be created
3. Consider explaining the Docker flags (-v, -it, --rm) for users new to Docker

 Basic usage (current directory):
 
 ```bash
 docker run -v .:/app -it --rm ghcr.io/yamadashy/repomix

+The command explained:
+- -v .:/app: Mounts the current directory to /app in the container
+- -it: Enables interactive mode with a pseudo-TTY
+- --rm: Automatically removes the container when it exits
+
+The output file will be created in your current directory.

---

`111-113`: **Clarify remote repository Docker usage**

The remote repository example needs additional context:
1. Explain why we use an `output` directory instead of the current directory
2. Clarify that the user needs to create the output directory first
3. Consider providing a complete example with directory creation


```diff
 Process a remote repository and output to a `output` directory:
 
 ```bash
+# Create an output directory first
+mkdir output
+
 docker run -v ./output:/app -it --rm ghcr.io/yamadashy/repomix --remote https://github.com/yamadashy/repomix

+Note: When processing a remote repository, we mount a separate output directory instead
+of the current directory since we don't need to analyze local files.

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used: CodeRabbit UI**
**Review profile: CHILL**
**Plan: Pro**

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 3ac15016db3ae058f9b85fc3a9c64db9c737ca37 and 5f80c0a2418c9732a60ef418f639076a5941f723.

</details>

<details>
<summary>📒 Files selected for processing (1)</summary>

* `README.md` (1 hunks)

</details>

<details>
<summary>🔇 Additional comments (1)</summary>

<details>
<summary>README.md (1)</summary>

`101-105`: **LGTM! Clear and informative introduction.**

The Docker section introduction effectively explains the purpose and benefits of using Docker with Repomix.

</details>

</details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.07%. Comparing base (3ac1501) to head (145e5af).
Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #230   +/-   ##
=======================================
  Coverage   92.07%   92.07%           
=======================================
  Files          44       44           
  Lines        2058     2058           
  Branches      450      450           
=======================================
  Hits         1895     1895           
  Misses        163      163           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[standard-input]

No issues flagged.
Standard Input can make mistakes. Check important info.