Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,9 @@ 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
```
Expand Down Expand Up @@ -288,6 +291,7 @@ This format provides a clean, readable structure that is both human-friendly and
- `--output-show-line-numbers`: Show line numbers in the output
- `--copy`: Additionally copy generated output to system clipboard
- `--remote <url>`: Process a remote Git repository
- `--remote-branch <name>`: Specify the remote branch name, tag, or commit hash (defaults to repository default branch)
- `--verbose`: Enable verbose logging

Examples:
Expand Down Expand Up @@ -325,6 +329,12 @@ To process a remote repository, use the `--remote` option followed by the reposi
repomix --remote https://github.com/user/repo.git
```

You can specify the branch name, tag, or commit hash:

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

You can also use GitHub's shorthand format:

```bash
Expand Down
5 changes: 4 additions & 1 deletion src/cli/cliRun.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,10 @@ export const run = async () => {
.option('--init', 'initialize a new repomix.config.json file')
.option('--global', 'use global configuration (only applicable with --init)')
.option('--remote <url>', 'process a remote Git repository')
.option('--remote-branch <name>', 'select a specific branch or commit id')
.option(
'--remote-branch <name>',
'specify the remote branch name, tag, or commit hash (defaults to repository default branch)',
)
.action((directory = '.', options: CliOptions = {}) => executeAction(directory, process.cwd(), options));

await program.parseAsync(process.argv);
Expand Down