Skip to content

DEV-1427: docs: add profile management to README #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexeyzimarev merged 2 commits into from
Apr 11, 2026
Merged

DEV-1427: docs: add profile management to README #8

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
97932e8
docs: add profile management to README
alexeyzimarev Apr 11, 2026
c644d34
docs: clarify profile resolution works at directory level, not just g…
alexeyzimarev Apr 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,42 @@ kapacitor agent status # check if daemon is running
kapacitor agent stop # stop the background daemon
```

### Profiles

Profiles let you work with multiple Capacitor servers — for example, a company server for work repos and a separate one for open-source projects. Each profile stores its own server URL, visibility settings, and daemon configuration.

```bash
kapacitor profile add work --server-url https://cap.example.com
kapacitor profile add oss --server-url https://cap.oss.dev --remote "github.com/myorg/*"
kapacitor profile list
kapacitor profile show work
kapacitor profile remove work
```

The `--remote` flag associates a profile with git remote patterns. When you open a repo whose remote matches a pattern, that profile activates automatically.

#### Switching profiles

```bash
kapacitor use work # bind 'work' profile to current repo/directory
kapacitor use work --global # set 'work' as the global default
kapacitor use oss --save # bind and write .kapacitor.json for team sharing
```

Without `--global`, `use` binds the profile to the current git repo root (or the current directory if not in a repo). With `--save`, it writes a `.kapacitor.json` file that can be committed so the whole team uses the same profile.

#### Profile resolution order

The CLI resolves which profile to use in this order:

1. `--server-url` CLI flag
2. `KAPACITOR_URL` environment variable
3. `KAPACITOR_PROFILE` environment variable
4. `.kapacitor.json` in the repo root (or current directory if not in a repo)
5. Git remote pattern matching from `--remote` flags
6. Directory binding from `kapacitor use`
7. Global active profile (or `default`)

### Configuration

```bash
Expand All @@ -173,6 +209,8 @@ kapacitor config set excluded_repos "myorg/secret-project,personal/diary"

```bash
kapacitor status # server health check
kapacitor whoami # show current authenticated user
kapacitor login # authenticate via OAuth
kapacitor update # check for CLI updates
kapacitor logout # delete stored tokens
```
Expand Down
Loading