Tauri Command Reference
This document is generated from apps/desktop/src-tauri/src/commands/. When the generator re-runs, descriptions are
pulled from the Rust doc comments in that directory; the canonical names for agent and world-model concepts (the
“World Agent,” the “submit boundary,” etc.) live in those doc comments and should be kept consistent with the
Voice Guide.
Each command is exposed over Tauri IPC and callable from the React frontend via invoke('<command_name>', { ...args }).
Injected parameters (state, app, op_id) are omitted from the parameter column.
Total commands: across modules.
Agent
Source: apps/desktop/src-tauri/src/commands/agent.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
start_agent | state: State<'_, AppState> | Result<(), CommandError> | Start the World Agent runtime for the current workspace. |
stop_agent | state: State<'_, AppState> | Result<(), CommandError> | Stop the World Agent runtime. |
send_agent_message | state: State<'_, AppState>, message: String, skill: Option<String> | Result<(), CommandError> | Send a message to the agent. |
interrupt_agent | state: State<'_, AppState> | Result<(), CommandError> | Interrupt the currently running agent session. |
get_agent_status | state: State<'_, AppState> | Result<AgentStatusPayload, CommandError> | Get the current agent status. |
get_conversation_history | state: State<'_, AppState> | Result<Vec<ConversationMessagePayload>, CommandError> | Get the conversation history for the current session. |
clear_conversation | state: State<'_, AppState> | Result<(), CommandError> | Clear the conversation history. |
respond_permission_request | state: State<'_, AppState>, request_id: String, capability: String, response: PermissionResponse | Result<(), CommandError> | Respond to a pending agent permission request. |
Attachment
Source: apps/desktop/src-tauri/src/commands/attachment.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
upload_attachment | file_path: String | Result<Attachment, CommandError> | Upload a file as an attachment in the current workspace. |
upload_attachment_bytes | file_name: String, bytes: Vec<u8> | Result<Attachment, CommandError> | Upload raw bytes as an attachment in the current workspace. |
get_attachment | id: String | Result<Attachment, CommandError> | Get attachment metadata by ID. |
get_attachment_file | id: String | Result<Vec<u8>, CommandError> | Get the raw file bytes for an attachment. |
list_attachments | page_id: Option<String> | Result<Vec<Attachment>, CommandError> | List attachments in the current workspace. |
delete_attachment | id: String | Result<(), CommandError> | Delete an attachment by ID. |
get_attachment_variant | state: State<'_, AppState>, id: String, variant: ImageVariant | Result<Vec<u8>, CommandError> | Get an optimized image variant (thumbnail or display-optimized). |
get_storage_usage | — | Result<StorageUsage, CommandError> | Get storage usage for the current workspace. |
list_attachments_with_refs | — | Result<Vec<AttachmentSummary>, CommandError> | List all attachments with their reference counts. |
download_remote_attachment | state: State<'_, AppState>, workspace_cloud_id: String, id: String | Result<Vec<u8>, CommandError> | Download a remote-only attachment’s file bytes on demand. |
bulk_delete_attachments | ids: Vec<String>, force: bool | Result<(), CommandError> | Bulk delete attachments by ID. |
Auth
Source: apps/desktop/src-tauri/src/commands/auth.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
store_user_identity | user_id: String, email: String, display_name: Option<String> | Result<(), CommandError> | Store the user’s identity in the backend IdentityStore. |
get_user_identity | — | Result<Option<domain::AuthUser>, CommandError> | Get the currently stored user identity. |
clear_user_identity | — | Result<(), CommandError> | Clear the stored user identity. |
Bookmark
Source: apps/desktop/src-tauri/src/commands/bookmark.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
create_bookmark | name: String, description: Option<String> | Result<Bookmark, CommandError> | Create a new named bookmark anchored to the current time. |
get_bookmark | id: String | Result<Bookmark, CommandError> | Get a bookmark by ID. |
list_bookmarks | — | Result<Vec<Bookmark>, CommandError> | List all bookmarks, ordered by timestamp ascending. |
delete_bookmark | id: String | Result<(), CommandError> | Delete a bookmark by ID. |
Collection View
Source: apps/desktop/src-tauri/src/commands/collection_view.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
query_pages_by_type | type_slug: String, offset: u64, limit: u64 | Result<Vec<CollectionViewRow>, CommandError> | Query pages assigned to a type, with their property values. |
get_collection_view | type_slug: String | Result<Option<CollectionView>, CommandError> | Load the saved collection view config for a type. |
save_collection_view | view: CollectionView | Result<(), CommandError> | Persist a collection view configuration for a type. |
Container Rule
Source: apps/desktop/src-tauri/src/commands/container_rule.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
set_container_rule | folder_page_id: String, type_id: String, depth: String | Result<ContainerRule, CommandError> | Set (create) a container rule on a folder page. |
remove_container_rule | rule_id: String | Result<(), CommandError> | Remove a container rule by ID. |
get_container_rules | folder_page_id: String | Result<Vec<ContainerRule>, CommandError> | Get all container rules defined on a folder page. |
Embedding
Source: apps/desktop/src-tauri/src/commands/embedding.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
get_embedding_status | — | Result<IndexingStatus, CommandError> | Get the current embedding indexing status. |
rebuild_embedding_index | — | Result<(), CommandError> | Trigger a full embedding re-index of the current workspace. |
Event Log
Source: apps/desktop/src-tauri/src/commands/event_log.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
query_page_events | page_id: String, limit: Option<usize>, offset: Option<usize> | Result<Vec<EventLogEntry>, CommandError> | Query event log entries for a specific page (includes block events). |
query_page_timeline | page_id: String, limit: Option<usize>, offset: Option<usize> | Result<Vec<PageTimelineEntry>, CommandError> | Query the unified page timeline — structural events and content change indicators. |
query_timeline | start_rfc3339: String, end_rfc3339: String, limit: Option<usize>, offset: Option<usize> | Result<Vec<EventLogEntry>, CommandError> | Query event log entries within a time range. |
Filtered Tree
Source: apps/desktop/src-tauri/src/commands/filtered_tree.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
list_filtered_page_tree | type_slug: String | Result<Vec<FilteredTreeNode>, CommandError> | List the page tree filtered by a type slug. |
Import
Source: apps/desktop/src-tauri/src/commands/import.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
detect_import_source | path: String | Result<ImportSourceType, CommandError> | Detect the type of import source at the given path. |
analyze_import | path: String | Result<AnalyzeImportResponse, CommandError> | Analyze an import source before execution. |
scan_import_types | source_path: String | Result<Vec<TypeMapping>, CommandError> | Scan a source directory for page_type frontmatter values. |
execute_import | request: ImportRequest | Result<ImportWithWorkspaceResult, CommandError> | Execute an import into a new workspace (without progress reporting). |
execute_import_with_progress | request: ImportRequest | Result<ImportWithWorkspaceResult, CommandError> | Execute an import with progress reporting. |
get_default_import_path | — | Option<String> | Get the default import path (typically Downloads folder). |
Layout
Source: apps/desktop/src-tauri/src/commands/layout.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
list_layouts | — | Result<Vec<LayoutDefinition>, CommandError> | List all layout definitions in the current workspace. |
create_layout | name: String, description: Option<String>, icon: Option<String>, template: String | Result<LayoutDefinition, CommandError> | Create a new layout definition. |
update_layout | id: String, name: String, description: Option<String>, icon: Option<String>, template: String | Result<LayoutDefinition, CommandError> | Update an existing layout definition. |
delete_layout | id: String | Result<(), CommandError> | Delete a layout definition. |
Logging
Source: apps/desktop/src-tauri/src/commands/logging.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
log_frontend_event | level: String, event: String, context: String | () | Forward a structured log event from the frontend to the Rust tracing system. |
Mcp
Source: apps/desktop/src-tauri/src/commands/mcp.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
get_mcp_status | — | Result<McpStatus, CommandError> | Get the current MCP server status. |
get_mcp_token | — | Result<Option<String>, CommandError> | Get the MCP bearer token for the running server. |
set_mcp_enabled | enabled: bool | Result<McpStatus, CommandError> | Enable or disable the MCP server. |
regenerate_mcp_token | — | Result<McpStatus, CommandError> | Regenerate the MCP bearer token. |
Memory
Source: apps/desktop/src-tauri/src/commands/memory.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
list_agent_memories | scope: Option<String>, limit: Option<usize>, state: State<'_, AppState> | Result<Vec<MemoryEntryDto>, CommandError> | List agent memories, optionally filtered by scope. |
search_agent_memories | query: String, scope: Option<String>, limit: Option<usize>, state: State<'_, AppState> | Result<Vec<MemoryEntryDto>, CommandError> | Search memories by full-text query. |
delete_agent_memory | id: String, state: State<'_, AppState> | Result<(), CommandError> | Delete a single memory entry by ID. |
delete_all_agent_memories | scope: String, state: State<'_, AppState> | Result<(), CommandError> | Delete all memory entries in a given scope. |
get_memory_stats | state: State<'_, AppState> | Result<MemoryStatsDto, CommandError> | Get memory statistics — entry counts per scope and total. |
Model Download
Source: apps/desktop/src-tauri/src/commands/model_download.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
set_semantic_search_enabled | enabled: bool | Result<(), CommandError> | Enable or disable semantic search (persists to settings). |
cancel_model_download | — | Result<(), CommandError> | Cancel an in-progress embedding model download. |
trigger_model_download | state: State<'_, AppState> | Result<(), CommandError> | Manually trigger embedding model download. |
Ollama
Source: apps/desktop/src-tauri/src/commands/ollama.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
check_ollama_status | url: Option<String> | Result<OllamaStatus, CommandError> | Check if the Ollama server is running. |
get_ollama_models | url: Option<String> | Result<Vec<OllamaModelInfo>, CommandError> | List models currently installed on the Ollama server. |
get_recommended_models | — | Result<Vec<RecommendedModel>, CommandError> | Get hardware-aware model recommendations based on system RAM. |
get_system_capabilities | — | Result<SystemCapabilities, CommandError> | Get system hardware capabilities (total RAM, available RAM, hardware tier). |
pull_ollama_model | name: String, url: Option<String> | Result<(), CommandError> | Pull (download) an Ollama model with streaming progress events. |
Openrouter
Source: apps/desktop/src-tauri/src/commands/openrouter.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
start_openrouter_auth | — | Result<String, CommandError> | Start the OpenRouter OAuth PKCE flow. |
complete_openrouter_auth | code: String, state: State<'_, AppState> | Result<(), CommandError> | Complete the OpenRouter OAuth PKCE flow. |
Page
Source: apps/desktop/src-tauri/src/commands/page.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
create_page | title: String, parent_id: Option<String> | Result<CreatePageResult, CommandError> | Create a new page in the current workspace. |
get_page | page_id: String | Result<Page, CommandError> | Get a page by its slug from the current workspace. |
list_pages | — | Result<Vec<Page>, CommandError> | List all pages in the current workspace. |
update_page | page_id: String, title: Option<String>, content: Option<String> | Result<Page, CommandError> | Update a page’s metadata and/or content. |
list_page_tree | — | Result<Vec<PageTreeNode>, CommandError> | List pages as a tree structure for navigation. |
get_page_descendants | slug: String | Result<DescendantInfo, CommandError> | Get the number of descendants for a page (for delete confirmation). |
delete_page | page_id: String, cascade: bool | Result<DeletePageResult, CommandError> | Soft-delete a page (move to trash) and optionally all its descendants. |
list_trash | — | Result<Vec<DeletedPageInfo>, CommandError> | List all pages in the trash (soft-deleted pages). |
restore_page | slug: String, restore_ancestors: bool | Result<(), CommandError> | Restore a page from the trash. |
permanent_delete_page | slug: String | Result<(), CommandError> | Permanently delete a page from the trash. |
empty_trash | — | Result<EmptyTrashResult, CommandError> | Permanently delete all pages in the trash. |
move_page | slug: String, new_parent_slug: Option<String> | Result<String, CommandError> | Move a page to a new parent (or to root if new_parent_slug is None). |
export_pages | export_path: String | Result<ExportResult, CommandError> | Export all pages from the current workspace to markdown files. |
set_page_type | slug: String, page_type: PageType | Result<(), CommandError> | Set the type/category of a page. |
set_page_icon | slug: String, icon: Option<String>, icon_color: Option<String> | Result<(), CommandError> | Set the icon for a page. |
get_backlinks | slug: String | Result<Vec<BacklinkInfo>, CommandError> | Get all pages that link to the specified page (backlinks). |
get_outgoing_links | slug: String | Result<Vec<OutgoingLinkInfo>, CommandError> | Get all outgoing wiki-links from the specified page. |
get_page_detail | slug: String | Result<PageDetail, CommandError> | Get complete page detail including metadata, word count, backlinks, and outgoing links. |
rename_page_preview | slug: String, new_title: String | Result<RenamePlan, CommandError> | Preview a page rename operation without making changes. |
rename_page | slug: String, new_title: String | Result<RenamedPageInfo, CommandError> | Rename a page and update all links pointing to it. |
save_block_content | slug: String, content_bytes: Vec<u8>, content_text: String | Result<(), CommandError> | Save block content from binary LoroDoc bytes. |
get_block_content_snapshot | slug: String | Result<Vec<u8>, CommandError> | Get the current block content as a LoroDoc snapshot (binary). |
update_block_metadata | slug: String, block_id: String, content_type: domain::BlockContentType | Result<(), CommandError> | Update block content-type metadata (scale, alignment, caption, etc.) |
create_block | slug: String, content_type: domain::BlockContentType, position: u32 | Result<domain::Block, CommandError> | Create a new typed block in a page at the specified slot position. |
save_block_content_by_id | slug: String, block_id: String, content_bytes: Vec<u8>, content_text: String | Result<(), CommandError> | Save block content by block ID (for grid layout multi-editor). |
get_block_content_snapshot_by_id | slug: String, block_id: String | Result<Vec<u8>, CommandError> | Get the current block content as a LoroDoc snapshot by block ID. |
apply_layout | slug: String, layout_definition_id: String | Result<Page, CommandError> | Apply a layout definition to a page. |
remove_layout | slug: String | Result<(), CommandError> | Remove the layout from a page. |
create_block_in_area | slug: String, area: String, content_type: domain::BlockContentType | Result<domain::Block, CommandError> | Create a new block assigned to a named layout area. |
assign_block_to_area | slug: String, block_id: String, area: Option<String> | Result<(), CommandError> | Assign or unassign a block to a named layout area. |
check_links_resolution | slugs: Vec<String> | Result<Vec<bool>, CommandError> | Check which wiki-link slugs resolve to existing pages. |
check_layout_compatibility | slug: String, layout_definition_id: String | Result<LayoutCompatibilityResult, CommandError> | Check whether applying a layout definition would displace any blocks. |
Presence
Source: apps/desktop/src-tauri/src/commands/presence.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
get_active_participants | state: State<'_, AppState> | Result<Vec<ActiveParticipantDto>, CommandError> | Get the list of participants currently active in the workspace. |
Proactive
Source: apps/desktop/src-tauri/src/commands/proactive.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
get_pending_suggestions | state: State<'_, AppState> | Result<Vec<ProactiveSuggestionDto>, CommandError> | Get all pending (non-dismissed) proactive suggestions. |
dismiss_suggestion | state: State<'_, AppState>, suggestion_id: String | Result<bool, CommandError> | Dismiss a single proactive suggestion by ID. |
dismiss_all_suggestions | state: State<'_, AppState> | Result<(), CommandError> | Dismiss all proactive suggestions. |
Property
Source: apps/desktop/src-tauri/src/commands/property.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
list_properties | type_id: Option<String> | Result<Vec<PropertyDefinition>, CommandError> | List all property definitions in the current workspace. |
create_property | name: String, value_type: String, description: Option<String>, config: Option<String> | Result<PropertyDefinition, CommandError> | Create a new property definition. |
update_property | id: String, name: Option<String>, description: Option<String>, config: Option<String> | Result<PropertyDefinition, CommandError> | Update an existing property definition. |
delete_property | id: String | Result<(), CommandError> | Delete a property definition. |
Property Value
Source: apps/desktop/src-tauri/src/commands/property_value.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
get_page_properties | page_id: String | Result<Vec<PagePropertyView>, CommandError> | Get all property definitions and their current values for a page. |
set_property_value | page_id: String, property_slug: String, value: Option<serde_json::Value> | Result<(), CommandError> | Set or clear a property value on a page. |
Recent Workspaces
Source: apps/desktop/src-tauri/src/commands/recent_workspaces.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
list_recent_workspaces | — | Result<Vec<RecentWorkspace>, CommandError> | Get the list of recently opened workspaces. |
add_to_recent_workspaces | name: String, path: String | Result<(), CommandError> | Add a workspace to the recent list. |
remove_from_recent_workspaces | path: String | Result<(), CommandError> | Remove a workspace from the recent list. |
clear_recent_workspaces | — | Result<(), CommandError> | Clear all recent workspaces. |
refresh_recent_workspaces_menu | — | Result<(), CommandError> | Refresh the native Recent Workspaces menu. |
Search
Source: apps/desktop/src-tauri/src/commands/search.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
search_pages | state: State<'_, AppState>, query: String, limit: Option<usize> | Result<Vec<SearchResult>, CommandError> | Search pages in the current workspace. |
Settings
Source: apps/desktop/src-tauri/src/commands/settings.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
get_settings | — | Result<Settings, CommandError> | Get the current application settings. |
is_first_launch | — | Result<bool, CommandError> | Check if this is the first launch of the application. |
complete_first_launch | — | Result<(), CommandError> | Mark the first launch tour as completed. |
set_user_persona | persona: UserPersona | Result<(), CommandError> | Set the user’s persona during onboarding. |
set_preferred_sign_in_method | method: SignInMethod | Result<(), CommandError> | Set the user’s preferred sign-in method. |
analytics_opt_out | — | Result<(), CommandError> | Opt out of anonymous usage analytics. |
analytics_opt_in | — | Result<(), CommandError> | Opt in to anonymous usage analytics. |
analytics_is_opted_out | — | Result<bool, CommandError> | Check if analytics are opted out. |
get_agent_settings | — | Result<Option<AgentSettings>, CommandError> | Get the current agent settings. |
update_agent_settings | agent_settings: AgentSettings | Result<(), CommandError> | Update the agent settings. |
set_api_key | provider: AgentProvider, key: String | Result<(), CommandError> | Store a provider API key in the OS keychain. |
remove_api_key | provider: AgentProvider | Result<(), CommandError> | Remove a provider API key from the OS keychain. |
validate_api_key | provider: AgentProvider, key: String | Result<ApiKeyValidationResult, CommandError> | Validate a provider API key against the provider’s endpoint. |
Skill
Source: apps/desktop/src-tauri/src/commands/skill.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
list_skills | state: State<'_, AppState> | Result<Vec<SkillListItem>, CommandError> | List all skills — composite of system skills (SkillRegistry) and |
create_user_skill | state: State<'_, AppState>, id: String, name: String, description: String, system_template: String | Result<SkillListItem, CommandError> | Create a new user-authored skill. |
update_user_skill | state: State<'_, AppState>, id: String, name: String, description: String, system_template: String | Result<(), CommandError> | Update an existing user skill by overwriting it. |
delete_user_skill | state: State<'_, AppState>, id: String | Result<(), CommandError> | Delete a user skill by ID. Idempotent — no error if the skill does not exist. |
browse_marketplace | state: State<'_, AppState> | Result<Vec<SkillListItem>, CommandError> | Browse the locally cached marketplace skill catalogue. |
install_marketplace_skill | state: State<'_, AppState>, id: String, name: String, description: String, system_template: String | Result<SkillListItem, CommandError> | Install (cache locally) a skill from the marketplace. |
list_execution_traces | state: State<'_, AppState>, skill_id: String, limit: Option<u32> | Result<Vec<ExecutionTraceDto>, CommandError> | List execution traces for a given skill, most recent first. |
get_execution_trace | state: State<'_, AppState>, id: String | Result<Option<ExecutionTraceDto>, CommandError> | Get a specific execution trace by UUID. |
Sync
Source: apps/desktop/src-tauri/src/commands/sync.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
cloud_health_check | state: State<'_, AppState> | Result<String, CommandError> | Verify connectivity to the cloud backend. |
push_sync_queue | state: State<'_, AppState>, workspace_path: String, workspace_cloud_id: String, device_id: String | Result<PushSyncResult, CommandError> | Manually flush the sync queue, pushing all pending block updates to Supabase. |
store_auth_session | state: State<'_, AppState>, access_token: String, refresh_token: String | Result<(), CommandError> | Store auth session tokens (access + refresh). |
get_auth_session | state: State<'_, AppState> | Result<Option<(String, String)>, CommandError> | Retrieve stored auth session tokens. |
clear_auth_session | state: State<'_, AppState> | Result<(), CommandError> | Clear stored auth session tokens. |
register_device | state: State<'_, AppState>, device_name: String, platform: String | Result<domain::Device, CommandError> | Register a device with the Supabase backend. |
list_devices | state: State<'_, AppState> | Result<Vec<domain::Device>, CommandError> | List all devices registered to the current user. |
deauthorize_device | state: State<'_, AppState>, device_id: String | Result<(), CommandError> | Deauthorize (delete) a device by its ID. |
pull_sync_updates | state: State<'_, AppState>, workspace_path: String, workspace_cloud_id: String, device_id: String | Result<PullSyncResult, CommandError> | Pull remote block updates from Supabase and merge them locally. |
start_sync | workspace_path: String, workspace_cloud_id: String, device_id: String | Result<(), CommandError> | Start the background sync engine for the current workspace. |
stop_sync | — | Result<(), CommandError> | Stop the background sync engine. |
get_sync_status | state: State<'_, AppState> | Result<application::SyncStatus, CommandError> | Get the current sync engine status. |
trigger_pull_sync | — | Result<(), CommandError> | Trigger an immediate pull sync cycle via a realtime push notification. |
force_sync | — | Result<(), CommandError> | Force an immediate sync cycle outside the normal interval. |
push_page_metadata | state: State<'_, AppState>, workspace_cloud_id: String, device_id: String, fields: Vec<MetadataFieldInput> | Result<PushMetadataCommandResult, CommandError> | Push page metadata changes to the cloud. |
pull_page_metadata | state: State<'_, AppState>, workspace_path: String, workspace_cloud_id: String | Result<PullMetadataCommandResult, CommandError> | Pull page metadata from the cloud and apply LWW merge locally. |
push_page_deletion | state: State<'_, AppState>, workspace_cloud_id: String, device_id: String, page_id: String, page_title: Option<String> | Result<(), CommandError> | Push a page deletion tombstone to the cloud. |
pull_page_deletions | state: State<'_, AppState>, workspace_path: String, workspace_cloud_id: String | Result<PullDeletionsCommandResult, CommandError> | Pull page deletion tombstones from the cloud and apply locally. |
enable_workspace_sync | state: State<'_, AppState> | Result<EnableSyncCommandResult, CommandError> | Enable sync for the current workspace. |
disable_workspace_sync | — | Result<(), CommandError> | Disable sync for the current workspace. |
get_workspace_sync_status | — | Result<WorkspaceSyncStatusResult, CommandError> | Get the sync status for the current workspace. |
clone_cloud_workspace | state: State<'_, AppState>, cloud_id: String, workspace_name: String | Result<CloneWorkspaceResult, CommandError> | Clone a cloud workspace to local storage. |
list_cloud_workspaces | state: State<'_, AppState> | Result<Vec<CloudWorkspaceInfo>, CommandError> | List all cloud workspaces for the current user. |
Tag
Source: apps/desktop/src-tauri/src/commands/tag.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
create_tag | name: String, color: Option<String>, group_id: Option<String> | Result<Tag, CommandError> | Create a new tag in the current workspace. |
list_tags | — | Result<Vec<Tag>, CommandError> | List all tags in the current workspace. |
update_tag | id: String, name: String, color: Option<String>, group_id: Option<String> | Result<Tag, CommandError> | Update an existing tag. |
delete_tag | id: String | Result<(), CommandError> | Delete a tag by ID. |
merge_tags | source_id: String, target_id: String | Result<u32, CommandError> | Merge one tag into another, returning the number of pages updated. |
search_tags | query: String, limit: Option<usize> | Result<Vec<Tag>, CommandError> | Search tags by name prefix. |
get_page_tags | page_id: String | Result<Vec<TagSummary>, CommandError> | Get all tags associated with a page. |
set_page_tags | page_id: String, tag_names: Vec<String> | Result<(), CommandError> | Replace all tags on a page atomically. |
add_tag_to_page | page_id: String, tag_id: String | Result<(), CommandError> | Add a single tag to a page (no-op if already present). |
remove_tag_from_page | page_id: String, tag_id: String | Result<(), CommandError> | Remove a single tag from a page. |
create_tag_group | name: String, color: Option<String> | Result<TagGroup, CommandError> | Create a new tag group. |
list_tag_groups | — | Result<Vec<TagGroup>, CommandError> | List all tag groups in the current workspace. |
update_tag_group | id: String, name: String, color: Option<String>, sort_order: i32 | Result<TagGroup, CommandError> | Update an existing tag group. |
delete_tag_group | id: String | Result<(), CommandError> | Delete a tag group by ID. |
filter_pages_by_tags | tag_ids: Vec<String>, match_all: bool | Result<Vec<String>, CommandError> | Return page IDs that match the given tag filter. |
Task Runner
Source: apps/desktop/src-tauri/src/commands/task_runner.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
get_task_runner_health | — | Result<Vec<TaskHealthSnapshot>, CommandError> | Get the current health snapshots for all tasks in the per-workspace background task runner. |
Template
Source: apps/desktop/src-tauri/src/commands/template.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
fetch_template_catalog | state: State<'_, AppState> | Result<TemplateCatalog, CommandError> | Fetch the cloud template catalog. |
install_cloud_template | state: State<'_, AppState>, file_path: String | Result<TypeDefinition, CommandError> | Install a template from the cloud catalog into the current workspace. |
Type Def
Source: apps/desktop/src-tauri/src/commands/type_def.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
list_types | — | Result<Vec<TypeDefinition>, CommandError> | List all type definitions in the current workspace. |
create_type | name: String, description: Option<String>, icon: Option<String>, icon_color: Option<String> | Result<TypeDefinition, CommandError> | Create a new type definition. |
get_type | id: String | Result<TypeDefinition, CommandError> | Get a type definition by ID. |
update_type | id: String, name: Option<String>, description: Option<String>, icon: Option<String>, icon_color: Option<String>, default_layout_id: Option<Option<String>> | Result<TypeDefinition, CommandError> | Update an existing type definition. |
delete_type | id: String | Result<(), CommandError> | Delete a type definition. |
add_property_to_type | type_id: String, property_id: String | Result<(), CommandError> | Add a property to a type. |
remove_property_from_type | type_id: String, property_id: String | Result<(), CommandError> | Remove a property from a type. |
assign_type_to_page | page_id: String, type_id: String | Result<TypeAssignment, CommandError> | Assign a type to a page (Manual scope). |
remove_type_from_page | page_id: String, type_id: String | Result<(), CommandError> | Remove a type assignment from a page. |
get_page_types | page_id: String | Result<Vec<TypeAssignment>, CommandError> | Get all type assignments for a page. |
Workspace
Source: apps/desktop/src-tauri/src/commands/workspace.rs
| Command | Parameters | Return Type | Description |
|---|---|---|---|
initialize_workspace | path: Option<String>, name: Option<String> | Result<Workspace, CommandError> | Initialize a workspace at the default location or specified path. |
get_current_workspace | — | Result<Option<Workspace>, CommandError> | Get the currently active workspace. |
open_workspace | path: String | Result<Workspace, CommandError> | Open an existing workspace at the specified path. |
workspace_exists | path: String | bool | Check if a workspace exists at the given path. |
get_default_workspace_path | — | String | Get the default workspace path for the current environment. |
get_workspaces_dir | — | String | Get the workspaces directory for the current environment. |
check_folder_status | path: String | FolderStatus | Check the status of a folder for workspace creation. |
rename_workspace | new_name: String | Result<RenameWorkspaceCommandResult, CommandError> | Rename the current workspace. |
reload_embedding_pipeline | — | Result<(), CommandError> | Reload the embedding pipeline for the current workspace. |
close_workspace | — | Result<(), CommandError> | Close the current workspace. |
set_workspace_icon | icon: Option<String>, icon_color: Option<String> | Result<Workspace, CommandError> | Set or change the icon for the current workspace. |
Was this page helpful?
Thanks for your feedback!