Skip to content

Commit db0f878

Browse files
authored
assets, README: adds hero image, nav, and bridge mode (#21)
Signed-off-by: Remy Guercio <remy@tailscale.com>
1 parent 8c1e835 commit db0f878

2 files changed

Lines changed: 30 additions & 2 deletions

File tree

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,18 @@
1-
# aperture-cli
1+
<h1 align="center">aperture-cli</h1>
2+
3+
<p align="center">
4+
<a href="#supported-agents">Supported agents</a> |
5+
<a href="#installation">Installation</a> |
6+
<a href="#usage">Usage</a> |
7+
<a href="#development">Development</a>
8+
</p>
9+
10+
<p align="center">
11+
<img src="./assets/aperture-hero.png" alt="Aperture CLI">
12+
</p>
213

314
> [!WARNING]
4-
> **This repository is experimental.** It is under active development, may change significantly without notice.
15+
> **This repository is alpha software.** It is under active development and may change significantly without notice.
516
617
A CLI launcher for coding agents preconfigured to work with [Aperture](https://aperture.tailscale.com). It manages installation, configuration and environment variables that make using multiple providers and models very easy.
718

@@ -11,6 +22,8 @@ A CLI launcher for coding agents preconfigured to work with [Aperture](https://a
1122
- [Gemini CLI](https://github.com/google-gemini/gemini-cli)
1223
- [OpenCode](https://github.com/sst/opencode)
1324
- [Codex](https://github.com/openai/codex)
25+
- [GitHub Copilot CLI](https://docs.github.com/en/copilot/how-tos/copilot-cli/cli-getting-started)
26+
- [Claude Cowork](https://support.claude.com/en/articles/13345190-get-started-with-claude-cowork)
1427

1528
## Installation
1629

@@ -32,6 +45,21 @@ aperture
3245

3346
On first run, `aperture` will attempt to connect to `http://ai`. If it cannot reach that host, it will prompt you to configure an Aperture endpoint.
3447

48+
### Bridge mode
49+
50+
Bridge mode lets Aperture CLI reach an Aperture endpoint through an embedded Tailscale node. Only the Aperture CLI proxy appears on the tailnet; the rest of the machine does not need the full Tailscale client installed or connected to that tailnet.
51+
52+
This is useful on machines where installing Tailscale is not practical, where Aperture needs to work alongside another VPN, or where you need to switch tailnets while continuing to use a single Aperture instance.
53+
54+
To use bridge mode:
55+
56+
1. Open `Settings`, then open `Bridges` and press `a` to add a bridge.
57+
2. Go back to `Settings`, then open `Aperture Endpoints` and press `a` to add an endpoint.
58+
3. Choose `Bridge`, select the bridge you created, then enter the Aperture URL.
59+
4. Select the bridged endpoint so it becomes active.
60+
5. Follow the Tailscale login prompt for the bridge.
61+
6. Launch an agent.
62+
3563
### Flags
3664

3765
| Flag | Description |

assets/aperture-hero.png

253 KB
Loading

0 commit comments

Comments
 (0)