scriptoriumadmin/fabro
1
0
Fork 0
mirror of https://github.com/fabro-sh/fabro.git synced 2026-08-28 05:27:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

docs: update CLI reference and GitHub integration for recent changes

Browse source 
Add fabro uninstall, pr create --force, secret list metadata, and
install owner selection to CLI reference. Add GitHub App owner
selection step to integration setup flow.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
Bryan Helmkamp 2026-04-12 17:07:28 -04:00
parent 85e068ffa9
commit 7f9f4e964e
3 changed files with 27 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.claude/skills/docs/watermark
View file

@ -1 +1 @@
6c53fc29b5f1309bfd026a883a23006db2bb441c f67bebae4b58380b84341d57471e75a197e76e45

10
docs/integrations/github.mdx
View file

@ -45,7 +45,9 @@ The rest of this page describes the `app` strategy, which is required for browse
1. Navigate to the web app (default `http://localhost:3000`). If no GitHub App is configured, you'll be redirected to the setup page automatically. 1. Navigate to the web app (default `http://localhost:3000`). If no GitHub App is configured, you'll be redirected to the setup page automatically.
2. Click **Register GitHub App**. This takes you to GitHub with a pre-filled [App Manifest](https://docs.github.com/en/apps/sharing-github-apps/registering-a-github-app-from-a-manifest) containing: 2. Choose where to register the app. If you have the `gh` CLI installed, Fabro detects your GitHub username and any organizations you administer and lets you pick. For organization-owned apps, the app is registered under that org's settings. If `gh` is not available, the app is registered under your personal account.
3. Click **Register GitHub App**. This takes you to GitHub with a pre-filled [App Manifest](https://docs.github.com/en/apps/sharing-github-apps/registering-a-github-app-from-a-manifest) containing:
| Permission | Level | Purpose | | Permission | Level | Purpose |
|---|---|---| |---|---|---|
@ -56,15 +58,15 @@ The rest of this page describes the `app` strategy, which is required for browse
| Issues | Write | Create issues from workflows | | Issues | Write | Create issues from workflows |
| Emails | Read | Read verified email for OAuth login | | Emails | Read | Read verified email for OAuth login |
3. Review the permissions on GitHub and click **Create GitHub App**. 4. Review the permissions on GitHub and click **Create GitHub App**.
4. GitHub redirects back to Fabro, which automatically: 5. GitHub redirects back to Fabro, which automatically:
- Exchanges the temporary code for permanent app credentials - Exchanges the temporary code for permanent app credentials
- Writes `app_id`, `client_id`, and `slug` to `~/.fabro/settings.toml` - Writes `app_id`, `client_id`, and `slug` to `~/.fabro/settings.toml`
- Stores `GITHUB_APP_CLIENT_SECRET`, `GITHUB_APP_WEBHOOK_SECRET`, and `GITHUB_APP_PRIVATE_KEY` in `<data_dir>/server.env` - Stores `GITHUB_APP_CLIENT_SECRET`, `GITHUB_APP_WEBHOOK_SECRET`, and `GITHUB_APP_PRIVATE_KEY` in `<data_dir>/server.env`
- Marks the change as restart-bound so the server must be restarted before login - Marks the change as restart-bound so the server must be restarted before login
5. **Install the app** on your GitHub account or organization. Go to `https://github.com/settings/apps/<your-app-slug>/installations` and install it on the repositories Fabro should access. 6. **Install the app** on your GitHub account or organization. Go to `https://github.com/settings/apps/<your-app-slug>/installations` and install it on the repositories Fabro should access.
### Verify the configuration ### Verify the configuration

22
docs/reference/cli.mdx
View file

@ -414,14 +414,16 @@ Create a GitHub pull request from a completed workflow run. Uses the run's persi
```bash ```bash
fabro pr create <run-id> fabro pr create <run-id>
fabro pr create <run-id> --model claude-opus-4-6 fabro pr create <run-id> --model claude-opus-4-6
fabro pr create <run-id> --force
``` ```
| Argument / Flag | Description | | Argument / Flag | Description |
|---|---| |---|---|
| `<RUN_ID>` | Run ID or prefix (required) | | `<RUN_ID>` | Run ID or prefix (required) |
| `--model <MODEL>` | LLM model for generating the PR description | | `--model <MODEL>` | LLM model for generating the PR description |
| `-f, --force` | Create PR even if the run status is not success or partial success |
The run must have completed successfully (or with partial success) and have a stored diff with changes. The run must have completed successfully (or with partial success) and have a stored diff with changes. Use `--force` to override the status check.
### `fabro pr list` ### `fabro pr list`
@ -823,6 +825,21 @@ fabro install --web-url https://fabro.example.com
|---|---|---| |---|---|---|
| `--web-url <URL>` | Web UI base URL for OAuth callback endpoints | `http://localhost:3000` | | `--web-url <URL>` | Web UI base URL for OAuth callback endpoints | `http://localhost:3000` |
When configuring a GitHub App, the wizard detects your GitHub organizations (via the `gh` CLI) and lets you choose whether to register the app under your personal account or an organization.
## `fabro uninstall`
Remove Fabro's local state, server data, and configuration files. Stops the server if it is running, removes the data directory, cleans up shell PATH entries, and optionally removes the binary.
```bash
fabro uninstall
fabro uninstall --yes
```
| Flag | Description |
|---|---|
| `--yes` | Skip confirmation prompt |
--- ---
## `fabro secret set` ## `fabro secret set`
@ -840,10 +857,11 @@ fabro secret set ANTHROPIC_API_KEY sk-ant-...
## `fabro secret list` ## `fabro secret list`
List server-owned secret names. Values are never returned after storage. List server-owned secrets with their name, type, and last-updated timestamp. Values are never returned after storage.
```bash ```bash
fabro secret list fabro secret list
fabro secret list --json
``` ```
## `fabro secret rm` ## `fabro secret rm`