Skip to content

docs(readme): Improve remote repository usage examples #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yamadashy merged 1 commit into from
Dec 31, 2024
Merged

docs(readme): Improve remote repository usage examples #232

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 16 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,11 +82,14 @@ To pack a remote repository:
```bash
repomix --remote https://github.com/yamadashy/repomix

# You can specify the branch name, tag, or commit hash:
repomix --remote https://github.com/yamadashy/repomix --remote-branch master

# You can also use GitHub shorthand:
repomix --remote yamadashy/repomix

# You can specify the branch name, tag, or commit hash:
repomix --remote https://github.com/yamadashy/repomix --remote-branch main

# Or use a specific commit hash:
repomix --remote https://github.com/yamadashy/repomix --remote-branch 935b695
```

To initialize a new configuration file (`repomix.config.json`):
Expand Down Expand Up @@ -323,7 +326,7 @@ repomix -o custom-output.txt
repomix -i "*.log,tmp" -v
repomix -c ./custom-config.json
repomix --style xml
repomix --remote https://github.com/user/repo.git
repomix --remote https://github.com/user/repo
npx repomix src
```

Expand All @@ -349,21 +352,25 @@ Repomix supports processing remote Git repositories without the need for manual
To process a remote repository, use the `--remote` option followed by the repository URL:

```bash
repomix --remote https://github.com/user/repo.git
repomix --remote https://github.com/yamadashy/repomix
```

You can specify the branch name, tag, or commit hash:
You can also use GitHub's shorthand format:

```bash
repomix --remote https://github.com/yamadashy/repomix --remote-branch master
repomix --remote yamadashy/repomix
```

You can also use GitHub's shorthand format:
You can specify the branch name, tag, or commit hash:

```bash
repomix --remote user/repo
repomix --remote https://github.com/yamadashy/repomix --remote-branch main
```

Or use a specific commit hash:
```bash
repomix --remote https://github.com/yamadashy/repomix --remote-branch 935b695
```

## ⚙️ Configuration

Expand Down