Add CLI Reference
parent
e3f0c31d94
commit
fd192b36f5
89
CLI-Reference.md
Normal file
89
CLI-Reference.md
Normal file
@ -0,0 +1,89 @@
|
|||||||
|
# CLI Reference
|
||||||
|
|
||||||
|
Project Journal includes a command-line interface under `journal.cli.main`.
|
||||||
|
|
||||||
|
## Basic Usage
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m journal.cli.main --help
|
||||||
|
```
|
||||||
|
|
||||||
|
## Vault Commands
|
||||||
|
|
||||||
|
Load encrypted vaults:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m journal.cli.main vault load
|
||||||
|
```
|
||||||
|
|
||||||
|
Save vaults:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m journal.cli.main vault save
|
||||||
|
```
|
||||||
|
|
||||||
|
Notes:
|
||||||
|
|
||||||
|
- Vault commands prompt for password.
|
||||||
|
- Vault files are monthly and encrypted.
|
||||||
|
|
||||||
|
## Search Commands
|
||||||
|
|
||||||
|
Search by text:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m journal.cli.main search "shutdown"
|
||||||
|
```
|
||||||
|
|
||||||
|
Search with filters:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m journal.cli.main search "trigger" --tag co-parent --type !TRIGGER --start-date 2026-02-01 --end-date 2026-02-21
|
||||||
|
```
|
||||||
|
|
||||||
|
Search by section:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m journal.cli.main search "anxiety" --section "Mental / Emotional Snapshot"
|
||||||
|
```
|
||||||
|
|
||||||
|
Search checkbox states:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m journal.cli.main search --checked Masking
|
||||||
|
python -m journal.cli.main search --unchecked Shutdown
|
||||||
|
```
|
||||||
|
|
||||||
|
## Server Commands
|
||||||
|
|
||||||
|
Start server:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m journal.cli.main server start
|
||||||
|
```
|
||||||
|
|
||||||
|
Stop server:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m journal.cli.main server stop
|
||||||
|
```
|
||||||
|
|
||||||
|
## AI Chat Command
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m journal.cli.main chat "Summarize my last week patterns."
|
||||||
|
```
|
||||||
|
|
||||||
|
## Devices Command
|
||||||
|
|
||||||
|
List microphones:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
python -m journal.cli.main devices list
|
||||||
|
```
|
||||||
|
|
||||||
|
## Common Errors
|
||||||
|
|
||||||
|
- `No decrypted journal entries found`: run `vault load` first.
|
||||||
|
- Date parsing errors: use `YYYY-MM-DD` for date filters.
|
||||||
|
- No microphone listed: check device permissions and drivers.
|
||||||
Loading…
x
Reference in New Issue
Block a user