Interact with the YouMind API to manage boards, crafts, notes, picks, and other content through the youmind CLI.
npm install -g @youmind-ai/cli
To verify installation: youmind (should print usage info).
If the command is not found, install it first before proceeding.
If you do not have a YouMind API key yet, generate one at:
https://youmind.com/settings/api-keys
Then set it as an environment variable:
export YOUMIND_API_KEY=sk-ym-xxx
Or pass per-command with --api-key sk-ym-xxx.
Three commands following a discover → inspect → execute workflow:
youmind search [query]
search board, search craft){ name, summary } objectsyoumind info <name>
$ref references are resolved inlineyoumind call <name> [params]
Requires authentication. Three ways to pass parameters:
# Key-value pairs
youmind call createBoard --name "My Board"
# JSON string
youmind call createBoard '{"name":"My Board"}'
# Stdin pipe
echo '{"name":"My Board"}' | youmind call createBoard
To accomplish a task with the YouMind API:
youmind search youmind info youmind call [params] # Find board-related APIs
youmind search board
# Check createBoard schema
youmind info createBoard
# Create the board
youmind call createBoard --name "Research Notes"
# Find note APIs and create a note
youmind search note
youmind info createNote
youmind call createNote '{"title":"First Note","boardId":"..."}'
| Option | Description |
|---|---|
| -------- | ------------- |
--api-key | API key (overrides YOUMIND_API_KEY env var) |
--endpoint | API endpoint (default: https://youmind.com) |
共 3 个版本