clavitor/clavis/README.md

55 lines
1.6 KiB
Markdown

# Clavis
Secure vault platform with multi-client support.
## Architecture
**Clavis is the vault server.** Everything else is a client that talks to it.
## Structure
### Active Development
| Directory | Purpose | Status |
|-----------|---------|--------|
| `clavis-vault/` | Vault server with embedded UI (Go, FIPS 140-3) | **Active** |
| `clavis-crypto/` | JavaScript crypto layer | **Active** |
| `clavis-cli/` | CLI for agents | **Active** |
| `clavis-chrome/` | Chrome browser extension | **Active** |
### Planned
| Directory | Purpose | Status |
|-----------|---------|--------|
| `clavis-firefox/` | Firefox browser extension | Announced |
| `clavis-safari/` | Safari browser extension | Announced |
| `clavis-ios/` | iOS native app | Announced |
| `clavis-android/` | Android native app | Announced |
## Build
```bash
make deploy # Build + test + restart everything
make deploy-vault # Build + test + restart vault only
make deploy-web # Build + restart website only
make status # Check running processes
make logs-vault # Tail vault logs
make logs-web # Tail web logs
```
## Clients
The vault supports multiple client types:
- **Web**: Built-in UI served by vault (`clavis-vault/`)
- **CLI**: Command-line tool for automation/agents (`clavis-cli/`)
- **Browser Extension**: Auto-fill and TOTP in Chrome (`clavis-chrome/`)
- **Mobile**: Native iOS/Android apps (planned)
## Security
- FIPS 140-3 validated crypto (BoringCrypto via GOEXPERIMENT)
- Zero-knowledge architecture
- Vault server is the single source of truth
## License
Proprietary — © Clavitor