marketing-shibata50/multica
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update credential docs for per-skill .env files

Browse source 
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Jiayuan Zhang 2026-02-15 04:24:09 +08:00
parent bd0b380e2e
commit 0678431a7d
3 changed files with 39 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

27
docs/credentials.md
View file

@ -8,7 +8,6 @@ multica credentials init
Creates:
- `~/.super-multica/credentials.json5` — LLM providers + tools
- `~/.super-multica/skills.env.json5` — skill/plugin API keys
Example `credentials.json5`:
@ -27,6 +26,32 @@ Example `credentials.json5`:
}
```
## Skill API Keys
Skill-specific API keys are stored in `.env` files within each skill's directory:
```
~/.super-multica/skills/<skill-id>/.env
```
Example for the `earnings-analysis` skill:
```bash
# ~/.super-multica/skills/earnings-analysis/.env
FINANCIAL_DATASETS_API_KEY=your-key-here
```
Skills declare their required environment variables in `SKILL.md` frontmatter:
```yaml
metadata:
requires:
env:
- FINANCIAL_DATASETS_API_KEY
```
The `.env` file is preserved across skill upgrades and is never committed to version control.
## LLM Providers
**OAuth Providers** (external CLI login):

21
docs/product-capabilities.md
View file

@ -744,7 +744,7 @@ Whitelisted devices reconnect without needing a new token or user confirmation.
| File | Purpose | Permissions |
|------|---------|-------------|
| `~/.super-multica/credentials.json5` | LLM providers + tool API keys | 0o600 |
| `~/.super-multica/skills.env.json5` | Skill/plugin environment variables | 0o600 |
| `~/.super-multica/skills/<id>/.env` | Per-skill environment variables | 0o600 |
Format: JSON5 (supports comments, trailing commas, unquoted keys).
@ -771,23 +771,22 @@ Format: JSON5 (supports comments, trailing commas, unquoted keys).
}
```
#### 4.11.3 skills.env.json5 Structure
#### 4.11.3 Per-Skill .env Files
```json5
{
env: {
LINEAR_API_KEY: "lin-...",
GITHUB_TOKEN: "ghp_...",
},
}
Each skill can have a `.env` file in its directory for API keys:
```bash
# ~/.super-multica/skills/earnings-analysis/.env
FINANCIAL_DATASETS_API_KEY=your-key-here
```
Skills declare required env vars in `SKILL.md` frontmatter under `metadata.requires.env`.
#### 4.11.4 Environment Variable Overrides
| Variable | Purpose |
|----------|---------|
| `SMC_CREDENTIALS_PATH` | Override credentials.json5 path |
| `SMC_SKILLS_ENV_PATH` | Override skills.env.json5 path |
| `SMC_CREDENTIALS_DISABLE=1` | Disable credentials loading |
---
@ -1051,7 +1050,7 @@ button, input, textarea, card, dialog, alert-dialog, dropdown-menu, select, comb
| Data | Location | Format | Lifetime |
|------|----------|--------|----------|
| Credentials | `~/.super-multica/credentials.json5` | JSON5 | User-managed |
| Skills env | `~/.super-multica/skills.env.json5` | JSON5 | User-managed |
| Skill API keys | `~/.super-multica/skills/<id>/.env` | dotenv | User-managed |
| Agent profiles | `~/.super-multica/agent-profiles/{id}/` | MD + JSON | User-managed |
| Agent memory | `~/.super-multica/agent-profiles/{id}/memory/` | JSON per key | Agent-managed |
| Sessions | `~/.super-multica/sessions/{id}/session.jsonl` | JSONL | Until deleted |