Skip to content

Commit 1e1bea2

Browse files
committed
docs: move quick start to top
1 parent b3b002f commit 1e1bea2

1 file changed

Lines changed: 23 additions & 18 deletions

File tree

README.md

Lines changed: 23 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,29 @@ AI Robot Review is a GitHub Action for pull request review with Codex CLI OAuth,
44

55
Current focus: a practical PR reviewer that can run from GitHub Actions, post a PR summary, post a small number of inline findings, and optionally fail the check on serious issues. The Codex path is designed to use a ChatGPT subscription OAuth login instead of OpenAI API billing.
66

7+
## Quick Start
8+
9+
Run the installer inside the local checkout of the repository you want to configure:
10+
11+
```bash
12+
cd /path/to/your-repo
13+
curl -fsSL https://raw.githubusercontent.com/777genius/multi-provider-code-review/main/scripts/install.sh | bash
14+
```
15+
16+
That is the recommended path because the installer can detect the GitHub remote, create a setup branch, write `.github/workflows/ai-robot-review.yml`, push the branch, and open a setup PR.
17+
18+
If you run it outside a git checkout, it can still ask for `owner/repo` and use the GitHub API, but the local-checkout flow is easier to inspect before merging.
19+
20+
The installer:
21+
22+
- detects or asks for the target `owner/repo`;
23+
- lets you choose `github-actions[bot]` or GitHub App bot identity;
24+
- lets you choose Codex subscription OAuth, Codex CLI with OpenAI API key, or OpenRouter API key;
25+
- creates `.github/workflows/ai-robot-review.yml` on a setup branch;
26+
- opens a setup PR instead of pushing directly to the default branch.
27+
28+
See [docs/install.md](./docs/install.md) for organization-level secrets, selected repositories, GitHub App setup, and security notes.
29+
730
## Status
831

932
This is an actively stabilized fork of `keithah/multi-provider-code-review`.
@@ -47,24 +70,6 @@ Available but still experimental:
4770
- No automatic deletion or moving of old inline discussions by default.
4871
- No claim that token or dollar cost is always available for Codex subscription OAuth. For OAuth runs the UI reports `OAuth subscription` instead of API billing cost.
4972

50-
## Quick Start
51-
52-
Run the installer from a local checkout of the repository you want to configure:
53-
54-
```bash
55-
curl -fsSL https://raw.githubusercontent.com/777genius/multi-provider-code-review/main/scripts/install.sh | bash
56-
```
57-
58-
The installer:
59-
60-
- detects or asks for the target `owner/repo`;
61-
- lets you choose `github-actions[bot]` or GitHub App bot identity;
62-
- lets you choose Codex subscription OAuth, Codex CLI with OpenAI API key, or OpenRouter API key;
63-
- creates `.github/workflows/ai-robot-review.yml` on a setup branch;
64-
- opens a setup PR instead of pushing directly to the default branch.
65-
66-
See [docs/install.md](./docs/install.md) for organization-level secrets, selected repositories, GitHub App setup, and security notes.
67-
6873
## Recommended Codex Workflow
6974

7075
```yaml

0 commit comments

Comments
 (0)