Skip to content

Commit baf704a

Browse files
committed
docs: document managed Enterprise setup
Lead installation guidance with managed SASE plugin install routes and add an ordered GitHub Enterprise setup checklist. SASE_AGENT=0b2.cld.f1 SASE_MACHINE=athena
1 parent e1f3b02 commit baf704a

2 files changed

Lines changed: 62 additions & 4 deletions

File tree

README.md

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,39 @@ management, and submission, along with GitHub-specific xprompt workflows.
1414

1515
## Installation
1616

17+
For a managed SASE install, install `sase-github` into the same `uv tool` environment as `sase` so its entry points are
18+
discovered by the `sase` command.
19+
20+
### Recommended: SASE Admin Center Updates tab
21+
22+
If SASE is already installed with `uv tool install sase`, open `sase ace`, press `#` for the SASE Admin Center, then go
23+
to the **Updates** tab (`5`, or `[` / `]`). Highlight `sase-github` in the plugin list (`j` / `k`, or `/` to filter),
24+
press `i` to install, and confirm the preview modal. The preview shows the exact `uv` command and resolved package set;
25+
the install runs as a tracked background task and is discovered on the next `sase` run.
26+
27+
See the core SASE docs for the [Updates tab](https://github.com/sase-org/sase/blob/master/docs/configuration.md#updates-tab)
28+
and [`sase plugin` commands](https://github.com/sase-org/sase/blob/master/docs/plugins.md).
29+
30+
### Alternative: install SASE and the plugin together
31+
1732
```bash
18-
pip install sase-github
33+
uv tool install sase --python 3.12 --with sase-github
1934
```
2035

21-
Or with [uv](https://docs.astral.sh/uv/):
36+
Repeat `--with` for additional plugins, for example `--with sase-github --with sase-telegram`. Add `--force` to replace
37+
an existing tool install.
38+
39+
### Equivalent CLI for an existing install
2240

2341
```bash
24-
uv pip install sase-github
42+
sase plugin install github
2543
```
2644

27-
Requires `sase>=0.1.3` as a dependency (installed automatically).
45+
`pip install sase-github` is only an escape hatch for non-managed or library-style environments. It is not the normal
46+
path for a `uv tool`-managed SASE command.
47+
48+
Requires `sase>=0.1.3` as a dependency. For GitHub Enterprise Server or self-hosted GitHub, follow the
49+
[GitHub Enterprise setup walkthrough](docs/configuration.md#github-enterprise-setup).
2850

2951
## What's Included
3052

@@ -74,6 +96,9 @@ workflows, and PR submission.
7496
- [gh](https://cli.github.com/) CLI (for GitHub API operations). For GitHub Enterprise, run
7597
`gh auth login --hostname <host>` for each configured Enterprise host.
7698

99+
See [Configuration](docs/configuration.md) for `github_hosts`, `github_orgs`, workspace layout, and the ordered GitHub
100+
Enterprise setup flow.
101+
77102
## Development
78103

79104
```bash

docs/configuration.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,38 @@
11
# Configuration
22

3+
## GitHub Enterprise setup
4+
5+
Use this checklist for GitHub Enterprise Server or another self-hosted GitHub host:
6+
7+
1. **Install SASE and `sase-github`.** Use the
8+
[README installation routes](../README.md#installation): the SASE Admin Center Updates tab is the recommended path
9+
for an existing managed install, while `uv tool install sase --python 3.12 --with sase-github` installs SASE and the
10+
plugin together. The core SASE [plugin docs](https://github.com/sase-org/sase/blob/master/docs/plugins.md) also cover
11+
`sase plugin install github` for existing installs.
12+
2. **Authenticate `gh` to the Enterprise host.**
13+
14+
```bash
15+
gh auth login --hostname github.mycompany.com
16+
```
17+
18+
Repo-scoped `gh` commands auto-detect the host from the git remote, so this host-specific login is enough for PR
19+
operations once the repo is cloned.
20+
3. **Set `github_hosts` in `~/.config/sase/sase.yml`.** **Put your Enterprise host first** if you want bare
21+
`#gh(owner/repo)` refs to clone from Enterprise. `github.com` is always included implicitly, but the first configured
22+
host is the default for bare refs; listing `github.com` first means bare refs default there instead. See
23+
[`github_hosts`](#github_hosts).
24+
4. **Optionally enable SSH clones.** Add owners to [`github_orgs`](#github_orgs) when you have an SSH key registered on
25+
that GitHub host and want SASE to clone those repos with `git@<host>:owner/repo.git`. Owners not listed in
26+
`github_orgs` use HTTPS.
27+
5. **Verify and resolve a repo.** Run:
28+
29+
```bash
30+
sase doctor -C plugins.github
31+
```
32+
33+
Then resolve a repo with `#gh(owner/repo)`. Enterprise workspaces are namespaced by host under
34+
`~/projects/github/<host>/<user>/<project>/`; see [Workspace Layout](#workspace-layout).
35+
336
## `github_hosts`
437

538
The `github_hosts` setting controls which GitHub hosts sase-github recognizes. Add it to your sase config file

0 commit comments

Comments
 (0)