CLI Reference

Complete command reference for the eidos CLI.

Global Options

Option	Description
-s, --space <id>	Target space ID (optional if in space directory)
-f, --format	Output format: table (default) or json
-h, --help	Show help
-V, --version	Show version

Node Commands

ls [path]

List nodes at the specified path.

eidos ls [path] [options]

Options:

Option	Description
-l, --long	Show detailed info (ID, type, created time)

cat <path>

View document content (markdown output).

eidos cat <path>

Note: Only works with documents. Use sql for table data.

mkdir <path>

Create a folder.

eidos mkdir <path>

touch <path>

Create a document.

eidos touch <path> [options]

Options:

Option	Description
-c, --content <text>	Initial document content

Piping:

cat file.md | eidos touch notes/doc
echo "text" | eidos touch notes/doc

mv <source> <destination>

Move or rename a node.

eidos mv <source> <destination>

append <path>

Append content to a document.

eidos append <path> [options]

Options:

Option	Description
-c, --content <text>	Content to append

Piping:

echo "text" | eidos append notes/doc

rm <path>

Delete a node.

eidos rm <path> [options]

Options:

Option	Description
-f, --force	Permanent delete (skip trash)
-r, --recursive	Required for folders

Query Commands

sql <query>

Execute read-only SQL queries.

eidos sql "SELECT * FROM eidos__tree WHERE type = 'doc'"

Caution

Read-only only. Do not use INSERT, UPDATE, or DELETE - they bypass transaction handling.

Table Commands

table ls

List all tables.

eidos table ls [options]

Options:

Option	Description
-l, --long	Show table IDs

table schema <table-id>

Show table schema.

eidos table schema <table-id>

Output columns:

Column	Description
Name	Field display name
ColumnName	Database column name (for SQL)
Type	Field type
Property	Formula expression (formula type only)

table import <table-id> (alias: add, append)

Import or append data records to a table from JSON.

eidos table import <table-id> [options]
# Shorthand for import
eidos table <table-id> < data.json

Options:

Option	Description
-d, --data <str>	Direct JSON array string
-i, --file <path>	Input JSON file

Piping:

cat data.json | eidos table tb_xxxx
opencli bilibili fav -f json | eidos table tb_xxxx

table create <name>

Create a new table with automated schema inference or explicit definitions.

eidos table create <name> [options]

Options:

Option	Description
-F, --fields <list>	Explicit fields (e.g., name:text,age:number)
-T, --template <id>	Copy schema from an existing table
-d, --data <str>	Sample JSON to infer schema from (CLI, stdin)
-i, --file <path>	Sample JSON file to infer schema from

Schema Inference + Import:

If data is provided via piping or --file during creation, the CLI will automatically infer the schema from the first record and import all data after the table is created.

# Create table "Favorites" and import items automatically
opencli bilibili fav -f json | eidos table create "Favorites"

Mount Commands

mount

List all mounts (default).

eidos mount
eidos mount -l

mount <name> <path>

Mount a directory.

eidos mount <name> <path>

Path handling:

• ~ expands to home directory
• Relative paths resolve to absolute
• Directory must exist

Access pattern: /@/<name>/filename

mount -u <name>

Unmount a directory.

eidos mount -u <name>

Extension Commands

ext deploy <path>

Deploy an extension.

eidos ext deploy <path> [options]

Options:

Option	Description
--slug <slug>	Update existing extension with this slug

File extensions:

• .tsx — Block with JSX components
• .ts — Pure TypeScript script

ext ls

List extensions.

eidos ext ls

ext rm <id>

Delete an extension.

eidos ext rm <id>

Space Commands

space ls

List all spaces.

eidos space ls

space open [id]

Open space in Eidos Desktop.

eidos space open
eidos space open <id>

Other Commands

status

Check connection to Eidos Desktop.

eidos status

completions <shell>

Generate shell completions.

eidos completions bash
eidos completions zsh
eidos completions fish