Skip to content

Commit d666d0b

Browse files
committed
docs: add supported URL formats and auth methods
1 parent b80913b commit d666d0b

File tree

1 file changed

+38
-3
lines changed

1 file changed

+38
-3
lines changed

README.md

Lines changed: 38 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,11 @@ Sync your OpenCode configurations across machines via Git, with optional encrypt
55
## Features
66

77
- **Cross-platform**: Works on Linux, macOS, and Windows
8+
- **Any git host**: GitHub, GitLab, Bitbucket, self-hosted, etc.
9+
- **Any auth method**: SSH keys, 1Password, gh auth, credential helpers
810
- **Standalone**: Works before OpenCode starts (no chicken-egg problem)
911
- **Interactive**: Guided setup and menu-driven interface
1012
- **Encrypted secrets**: Optional age encryption for sensitive data
11-
- **OAuth sync**: Optionally sync authentication tokens (encrypted)
1213

1314
## Installation
1415

@@ -34,10 +35,18 @@ go install github.com/GareArc/opencode-sync@latest
3435

3536
Download the latest release from the [releases page](https://github.com/GareArc/opencode-sync/releases).
3637

37-
### Homebrew (coming soon)
38+
### Homebrew (macOS/Linux)
3839

3940
```bash
40-
brew install GareArc/tap/opencode-sync
41+
brew tap GareArc/tap
42+
brew install opencode-sync
43+
```
44+
45+
### Scoop (Windows)
46+
47+
```powershell
48+
scoop bucket add garearc https://github.com/GareArc/scoop-bucket
49+
scoop install opencode-sync
4150
```
4251

4352
## Quick Start
@@ -90,6 +99,32 @@ For scripting or power users:
9099
| `opencode-sync doctor` | Diagnose issues |
91100
| `opencode-sync config` | Manage configuration |
92101

102+
## Requirements
103+
104+
- **git** must be installed and available in PATH
105+
106+
## Repository URL Formats
107+
108+
opencode-sync uses your system's git installation, so any URL format and authentication method your git supports will work:
109+
110+
```bash
111+
# SSH (recommended)
112+
git@github.com:username/repo.git
113+
git@gitlab.com:username/repo.git
114+
115+
# HTTPS
116+
https://github.com/username/repo.git
117+
https://gitlab.com/username/repo.git
118+
```
119+
120+
All standard git authentication methods are supported:
121+
- SSH keys (including 1Password SSH agent, ssh-agent)
122+
- HTTPS credentials via `gh auth login`
123+
- Git credential helpers (macOS Keychain, Windows Credential Manager, etc.)
124+
- `.netrc` files
125+
126+
Works with any git host: GitHub, GitLab, Bitbucket, self-hosted, etc.
127+
93128
## Configuration
94129

95130
Config file location:

0 commit comments

Comments
 (0)