You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Contributing to SuchConfig Desktop
1
+
# Contributing to SuchConfig
2
2
3
3
Thanks for helping improve the open-core desktop vault. This repo is the **Community Edition (CE)** surface: Project Vault, Secrets Vault, Trusted Folder, LAN P2P, and Vault Importer.
**Your local-first source of truth for configs, secrets, and teams.**
10
+
11
+
SuchConfig is the vault-and-collaboration product under the Such umbrella: project-scoped knowledge, secrets with placeholders, and credentials — offline by default, merge-friendly over time with CRDTs, with no cloud vault or sync of your note contents.
4
12
5
13
> **Heavy active development.** This is the first public cut of the open-core CE. APIs, UX, and sync behavior will change. Expect rough edges; please read [Current status](#current-status) before depending on any path in production.
6
14
7
15
Open core lets you audit the vault crypto and run a free local vault with user-owned backup (Trusted Folder) and opt-in LAN sync as those layers mature.
8
16
17
+
**Coming soon:** signed & notarized macOS installers (DMG), plus the public launch of [suchconfig.io](https://suchconfig.io). Until then, build from source or grab unsigned alpha builds from [GitHub Releases](https://github.com/suchconfig/suchconfig-app/releases).
18
+
9
19
|||
10
20
| --- | --- |
11
21
|**License**|[Apache-2.0](LICENSE)|
12
22
|**Platform**|**macOS primary**; Linux / Windows best-effort |
@@ -63,8 +73,8 @@ A **local-first vault** for AI-augmented development: project configs, secrets,
63
73
`mix` is only on your PATH after Elixir is installed **and** your shell has loaded asdf (or another Elixir install). Run Mix commands from **`phoenix-app/`**, not the repo root.
Asset deps from repo root: `pnpm run phoenix-assets:install`.
80
90
91
+
Once the app is running, `⌘K` / `Ctrl+K` opens the command palette. Full chord map: [docs/keyboard-shortcuts.md](docs/keyboard-shortcuts.md).
92
+
81
93
> Public Alpha CE resolves Mix / Cargo against the **vendored**`vault_core` in this tree. Private founder builds may use vendored CE dependencies ship in-tree.
82
94
83
95
---
84
96
85
97
## Architecture (trust boundary)
86
98
87
99
```
88
-
SuchConfig Desktop
100
+
SuchConfig
89
101
├── Tauri shell (Rust) — OS bridges, LAN P2P transport, passkey bridges
Copy file name to clipboardExpand all lines: docs/founders-vision.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Founder’s vision
2
2
3
-
SuchConfig Desktop exists so I can keep **project configs and secrets** in one **local-first** vault I control—on device, offline-capable, with CRDT merge for continuity I own (Trusted Folder, optional LAN sync). I dogfood it before anyone else.
3
+
SuchConfig exists so I can keep **project configs and secrets** in one **local-first** vault I control—on device, offline-capable, with CRDT merge for continuity I own (Trusted Folder, optional LAN sync). I dogfood it before anyone else.
Default shortcuts for SuchConfig. Inspired by [Linear](https://linear.app/docs/keyboard-shortcuts)-style sequences and [Alfred](https://www.alfredapp.com/help/getting-started/cheatsheet/)-style discoverability.
4
+
5
+
If a shortcut conflicts with OS or browser bindings, prefer the in-app command palette (`⌘K` / `Ctrl+K`).
6
+
7
+
Legend:
8
+
9
+
| Symbol | Meaning |
10
+
| --- | --- |
11
+
|`⌘`| Command (macOS) / mapped to Ctrl on Windows/Linux where noted |
12
+
|`⌃`| Control |
13
+
|`⇧`| Shift |
14
+
|`↵`| Return / Enter |
15
+
|`⎋`| Escape |
16
+
|`then`| Press keys in sequence within ~1s (not held together) |
17
+
18
+
---
19
+
20
+
## Global
21
+
22
+
| Shortcut | Action |
23
+
| --- | --- |
24
+
|`⌘K` / `Ctrl+K`| Open command palette |
25
+
|`⌃⇧L`| Lock vault (or prompt unlock when locked) |
Copy file name to clipboardExpand all lines: docs/local-first/local-first.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
-
# Local-First Strategy for SuchConfig Desktop
1
+
# Local-First Strategy for SuchConfig
2
2
3
3
## Core Philosophy
4
4
5
-
SuchConfig Desktop is built on a **local-first architecture** where vault data never leaves the machine unless the user explicitly exports or opts into a sync path they control. Inspired by local-first principles, SuchConfig prioritizes user ownership, privacy, and offline capability above all else.
5
+
SuchConfig is built on a **local-first architecture** where vault data never leaves the machine unless the user explicitly exports or opts into a sync path they control. Inspired by local-first principles, SuchConfig prioritizes user ownership, privacy, and offline capability above all else.
Copy file name to clipboardExpand all lines: docs/open-core.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# SuchConfig open core (Public Alpha)
2
2
3
-
SuchConfig Desktop is a **local-first Project Vault + Secrets Vault**. Configs and credentials stay on your device. Multi-device continuity is **user-owned** (Trusted Folder and optional LAN Wi‑Fi sync)—not a SuchConfig cloud vault.
3
+
SuchConfig is a **local-first Project Vault + Secrets Vault**. Configs and credentials stay on your device. Multi-device continuity is **user-owned** (Trusted Folder and optional LAN Wi‑Fi sync)—not a SuchConfig cloud vault.
4
4
5
5
**One-liner:** Open core audits the vault crypto and ships a free local vault with Trusted Folder and opt-in LAN sync as those layers mature.
6
6
@@ -31,6 +31,6 @@ SuchConfig Desktop is a **local-first Project Vault + Secrets Vault**. Configs a
31
31
32
32
## Maturity
33
33
34
-
Public Alpha tag: **`v1.0.0-alpha.5`**. See [public-alpha-roadmap.md](./public-alpha-roadmap.md). Platform: **macOS primary**; Linux/Windows best-effort.
34
+
Public Alpha tag: **`v1.0.0-alpha.6`**. See [public-alpha-roadmap.md](./public-alpha-roadmap.md). Platform: **macOS primary**; Linux/Windows best-effort.
35
35
36
36
Pricing / Stripe storefront stays hidden during alpha; Free download + this GitHub tree are the public surface.
0 commit comments