excalidraw collections
Organize scenes into workspace collections.
List, create, rename, delete, and populate collections in the current workspace.
excalidraw collections [options] [command]| Command | Description |
|---|---|
list | List workspace collections. |
get | Show one collection. |
create | Create a collection. |
update | Rename a collection. |
delete | Move a collection and its scenes to trash. |
scenes | List or create scenes inside a collection. |
Examples
excalidraw collections list --limit 50
excalidraw collections create --name "Product diagrams"
excalidraw collections scenes list <collectionId>Notes
- Use collection IDs with scenes commands to scope list and create operations.
list
Return collection metadata for the current workspace with optional pagination.
excalidraw collections list [options]| Option | Description |
|---|---|
--limit <number> | Maximum number of collections to return, from 1 to 100; default 5. |
--offset <number> | Number of collections to skip for offset pagination. |
--all | Fetch every page and print one combined list; --limit sets the page size. |
Examples
excalidraw collections list
excalidraw collections list --limit 100
excalidraw collections list --all --output tableNotes
- Use this to discover collection IDs before creating or moving scenes.
- With
--allthe output is { count, data } instead of a single page with hasNextPage.
get
Get metadata for a specific collection by ID.
excalidraw collections get [options] <collectionId>| Argument | Description |
|---|---|
<collectionId> | Collection ID returned by a list or create command. |
Examples
excalidraw collections get <collectionId>create
Create a workspace collection for grouping scenes by project, team, or topic.
excalidraw collections create [options]| Option | Description |
|---|---|
--name <name> | Name for the new collection. Required. |
Examples
excalidraw collections create --name "Roadmap"update
Update collection metadata. Currently, collections can be renamed.
excalidraw collections update [options] <collectionId>| Argument | Description |
|---|---|
<collectionId> | Collection ID to update. |
| Option | Description |
|---|---|
--name <name> | New collection name. Required. |
Examples
excalidraw collections update <collectionId> --name "Architecture"delete
Soft-delete a collection and every scene in it by moving them to trash. Nothing is permanently destroyed.
excalidraw collections delete [options] <collectionId>| Argument | Description |
|---|---|
<collectionId> | Collection ID to move to trash. |
Examples
excalidraw collections delete <collectionId>Notes
- Every scene in the collection is moved to trash along with it.
- Check collection contents before deletion with
collections scenes list.
scenes
Work with scenes through a collection-scoped view.
excalidraw collections scenes [options] [command]| Command | Description |
|---|---|
list | List scenes in one collection. |
create | Create a scene in a collection, optionally with content from a file. |
Examples
excalidraw collections scenes list <collectionId> --limit 25
excalidraw collections scenes create <collectionId> --name "New diagram"scenes list
Return scene metadata for a collection without fetching full canvas content.
excalidraw collections scenes list [options] <collectionId>| Argument | Description |
|---|---|
<collectionId> | Collection ID to list scenes from. |
| Option | Description |
|---|---|
--limit <number> | Maximum number of scenes to return, from 1 to 100; default 5. |
--offset <number> | Number of scenes to skip for offset pagination. |
--all | Fetch every page and print one combined list; --limit sets the page size. |
Examples
excalidraw collections scenes list <collectionId>
excalidraw collections scenes list <collectionId> --limit 100
excalidraw collections scenes list <collectionId> --all --output tableNotes
- With
--allthe output is { count, data } instead of a single page with hasNextPage.
scenes create
Create a scene in the selected collection. With --file, write its drawing content in the same run; without it, the scene starts empty.
excalidraw collections scenes create [options] <collectionId>| Argument | Description |
|---|---|
<collectionId> | Collection ID to create the scene in. |
| Option | Description |
|---|---|
--name <name> | Name for the new scene. Required. |
--pinned | Pin the scene in the workspace UI. |
--file <file> | Scene content JSON to write into the new scene; use - to read stdin. |
Examples
excalidraw collections scenes create <collectionId> --name "Onboarding map"
excalidraw collections scenes create <collectionId> --name "Pinned board" --pinned
excalidraw collections scenes create <collectionId> --name "Imported" --file drawing.excalidrawNotes
- Without
--filethe created scene starts empty. Useexcalidraw scenes content patchorexcalidraw scenes content putto add canvas content. - With
--file, a full Excalidraw export is written via PUT and a partial payload is merged via PATCH; seeexcalidraw scenes create --help.
Last updated on
