Skip to content
Documentation GitHub
Reference

Tauri Command Reference

This document is generated from apps/desktop/src-tauri/src/commands/.

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

CommandParametersReturn TypeDescription
start_agentstate: State<'_, AppState>Result<(), CommandError>Start the agent harness for the current workspace.
stop_agentstate: State<'_, AppState>Result<(), CommandError>Stop the agent harness.
send_agent_messagestate: State<'_, AppState>, message: String, skill: Option<String>Result<(), CommandError>Send a message to the agent.
interrupt_agentstate: State<'_, AppState>Result<(), CommandError>Interrupt the currently running agent session.
get_agent_statusstate: State<'_, AppState>Result<AgentStatusPayload, CommandError>Get the current agent status.
get_conversation_historystate: State<'_, AppState>Result<Vec<ConversationMessagePayload>, CommandError>Get the conversation history for the current session.
clear_conversationstate: State<'_, AppState>Result<(), CommandError>Clear the conversation history.
respond_permission_requeststate: State<'_, AppState>, request_id: String, capability: String, response: PermissionResponseResult<(), CommandError>Respond to a pending agent permission request.

Attachment

Source: apps/desktop/src-tauri/src/commands/attachment.rs

CommandParametersReturn TypeDescription
upload_attachmentfile_path: StringResult<Attachment, CommandError>Upload a file as an attachment in the current workspace.
upload_attachment_bytesfile_name: String, bytes: Vec<u8>Result<Attachment, CommandError>Upload raw bytes as an attachment in the current workspace.
get_attachmentid: StringResult<Attachment, CommandError>Get attachment metadata by ID.
get_attachment_fileid: StringResult<Vec<u8>, CommandError>Get the raw file bytes for an attachment.
list_attachmentspage_id: Option<String>Result<Vec<Attachment>, CommandError>List attachments in the current workspace.
delete_attachmentid: StringResult<(), CommandError>Delete an attachment by ID.
get_attachment_variantstate: State<'_, AppState>, id: String, variant: ImageVariantResult<Vec<u8>, CommandError>Get an optimized image variant (thumbnail or display-optimized).
get_storage_usageResult<StorageUsage, CommandError>Get storage usage for the current workspace.
list_attachments_with_refsResult<Vec<AttachmentSummary>, CommandError>List all attachments with their reference counts.
download_remote_attachmentstate: State<'_, AppState>, workspace_cloud_id: String, id: StringResult<Vec<u8>, CommandError>Download a remote-only attachment’s file bytes on demand.
bulk_delete_attachmentsids: Vec<String>, force: boolResult<(), CommandError>Bulk delete attachments by ID.

Auth

Source: apps/desktop/src-tauri/src/commands/auth.rs

CommandParametersReturn TypeDescription
store_user_identityuser_id: String, email: String, display_name: Option<String>Result<(), CommandError>Store the user’s identity in the backend IdentityStore.
get_user_identityResult<Option<domain::AuthUser>, CommandError>Get the currently stored user identity.
clear_user_identityResult<(), CommandError>Clear the stored user identity.

Bookmark

Source: apps/desktop/src-tauri/src/commands/bookmark.rs

CommandParametersReturn TypeDescription
create_bookmarkname: String, description: Option<String>Result<Bookmark, CommandError>Create a new named bookmark anchored to the current time.
get_bookmarkid: StringResult<Bookmark, CommandError>Get a bookmark by ID.
list_bookmarksResult<Vec<Bookmark>, CommandError>List all bookmarks, ordered by timestamp ascending.
delete_bookmarkid: StringResult<(), CommandError>Delete a bookmark by ID.

Collection View

Source: apps/desktop/src-tauri/src/commands/collection_view.rs

CommandParametersReturn TypeDescription
query_pages_by_typetype_slug: String, offset: u64, limit: u64Result<Vec<CollectionViewRow>, CommandError>Query pages assigned to a type, with their property values.
get_collection_viewtype_slug: StringResult<Option<CollectionView>, CommandError>Load the saved collection view config for a type.
save_collection_viewview: CollectionViewResult<(), CommandError>Persist a collection view configuration for a type.

Container Rule

Source: apps/desktop/src-tauri/src/commands/container_rule.rs

CommandParametersReturn TypeDescription
set_container_rulefolder_page_id: String, type_id: String, depth: StringResult<ContainerRule, CommandError>Set (create) a container rule on a folder page.
remove_container_rulerule_id: StringResult<(), CommandError>Remove a container rule by ID.
get_container_rulesfolder_page_id: StringResult<Vec<ContainerRule>, CommandError>Get all container rules defined on a folder page.

Embedding

Source: apps/desktop/src-tauri/src/commands/embedding.rs

CommandParametersReturn TypeDescription
get_embedding_statusResult<IndexingStatus, CommandError>Get the current embedding indexing status.
rebuild_embedding_indexResult<(), CommandError>Trigger a full embedding re-index of the current workspace.

Event Log

Source: apps/desktop/src-tauri/src/commands/event_log.rs

CommandParametersReturn TypeDescription
query_page_eventspage_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_timelinepage_id: String, limit: Option<usize>, offset: Option<usize>Result<Vec<PageTimelineEntry>, CommandError>Query the unified page timeline — structural events and content change indicators.
query_timelinestart_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

CommandParametersReturn TypeDescription
list_filtered_page_treetype_slug: StringResult<Vec<FilteredTreeNode>, CommandError>List the page tree filtered by a type slug.

Import

Source: apps/desktop/src-tauri/src/commands/import.rs

CommandParametersReturn TypeDescription
detect_import_sourcepath: StringResult<ImportSourceType, CommandError>Detect the type of import source at the given path.
analyze_importpath: StringResult<AnalyzeImportResponse, CommandError>Analyze an import source before execution.
scan_import_typessource_path: StringResult<Vec<TypeMapping>, CommandError>Scan a source directory for page_type frontmatter values.
execute_importrequest: ImportRequestResult<ImportWithWorkspaceResult, CommandError>Execute an import into a new workspace (without progress reporting).
execute_import_with_progressrequest: ImportRequestResult<ImportWithWorkspaceResult, CommandError>Execute an import with progress reporting.
get_default_import_pathOption<String>Get the default import path (typically Downloads folder).

Layout

Source: apps/desktop/src-tauri/src/commands/layout.rs

CommandParametersReturn TypeDescription
list_layoutsResult<Vec<LayoutDefinition>, CommandError>List all layout definitions in the current workspace.
create_layoutname: String, description: Option<String>, icon: Option<String>, template: StringResult<LayoutDefinition, CommandError>Create a new layout definition.
update_layoutid: String, name: String, description: Option<String>, icon: Option<String>, template: StringResult<LayoutDefinition, CommandError>Update an existing layout definition.
delete_layoutid: StringResult<(), CommandError>Delete a layout definition.

Logging

Source: apps/desktop/src-tauri/src/commands/logging.rs

CommandParametersReturn TypeDescription
log_frontend_eventlevel: 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

CommandParametersReturn TypeDescription
get_mcp_statusResult<McpStatus, CommandError>Get the current MCP server status.
get_mcp_tokenResult<Option<String>, CommandError>Get the MCP bearer token for the running server.
set_mcp_enabledenabled: boolResult<McpStatus, CommandError>Enable or disable the MCP server.
regenerate_mcp_tokenResult<McpStatus, CommandError>Regenerate the MCP bearer token.

Memory

Source: apps/desktop/src-tauri/src/commands/memory.rs

CommandParametersReturn TypeDescription
list_agent_memoriesscope: Option<String>, limit: Option<usize>, state: State<'_, AppState>Result<Vec<MemoryEntryDto>, CommandError>List agent memories, optionally filtered by scope.
search_agent_memoriesquery: String, scope: Option<String>, limit: Option<usize>, state: State<'_, AppState>Result<Vec<MemoryEntryDto>, CommandError>Search memories by full-text query.
delete_agent_memoryid: String, state: State<'_, AppState>Result<(), CommandError>Delete a single memory entry by ID.
delete_all_agent_memoriesscope: String, state: State<'_, AppState>Result<(), CommandError>Delete all memory entries in a given scope.
get_memory_statsstate: 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

CommandParametersReturn TypeDescription
set_semantic_search_enabledenabled: boolResult<(), CommandError>Enable or disable semantic search (persists to settings).
cancel_model_downloadResult<(), CommandError>Cancel an in-progress embedding model download.
trigger_model_downloadstate: State<'_, AppState>Result<(), CommandError>Manually trigger embedding model download.

Ollama

Source: apps/desktop/src-tauri/src/commands/ollama.rs

CommandParametersReturn TypeDescription
check_ollama_statusurl: Option<String>Result<OllamaStatus, CommandError>Check if the Ollama server is running.
get_ollama_modelsurl: Option<String>Result<Vec<OllamaModelInfo>, CommandError>List models currently installed on the Ollama server.
get_recommended_modelsResult<Vec<RecommendedModel>, CommandError>Get hardware-aware model recommendations based on system RAM.
get_system_capabilitiesResult<SystemCapabilities, CommandError>Get system hardware capabilities (total RAM, available RAM, hardware tier).
pull_ollama_modelname: 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

CommandParametersReturn TypeDescription
start_openrouter_authResult<String, CommandError>Start the OpenRouter OAuth PKCE flow.
complete_openrouter_authcode: String, state: State<'_, AppState>Result<(), CommandError>Complete the OpenRouter OAuth PKCE flow.

Page

Source: apps/desktop/src-tauri/src/commands/page.rs

CommandParametersReturn TypeDescription
create_pagetitle: String, parent_id: Option<String>Result<CreatePageResult, CommandError>Create a new page in the current workspace.
get_pagepage_id: StringResult<Page, CommandError>Get a page by its slug from the current workspace.
list_pagesResult<Vec<Page>, CommandError>List all pages in the current workspace.
update_pagepage_id: String, title: Option<String>, content: Option<String>Result<Page, CommandError>Update a page’s metadata and/or content.
list_page_treeResult<Vec<PageTreeNode>, CommandError>List pages as a tree structure for navigation.
get_page_descendantsslug: StringResult<DescendantInfo, CommandError>Get the number of descendants for a page (for delete confirmation).
delete_pagepage_id: String, cascade: boolResult<DeletePageResult, CommandError>Soft-delete a page (move to trash) and optionally all its descendants.
list_trashResult<Vec<DeletedPageInfo>, CommandError>List all pages in the trash (soft-deleted pages).
restore_pageslug: String, restore_ancestors: boolResult<(), CommandError>Restore a page from the trash.
permanent_delete_pageslug: StringResult<(), CommandError>Permanently delete a page from the trash.
empty_trashResult<EmptyTrashResult, CommandError>Permanently delete all pages in the trash.
move_pageslug: 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_pagesexport_path: StringResult<ExportResult, CommandError>Export all pages from the current workspace to markdown files.
set_page_typeslug: String, page_type: PageTypeResult<(), CommandError>Set the type/category of a page.
set_page_iconslug: String, icon: Option<String>, icon_color: Option<String>Result<(), CommandError>Set the icon for a page.
get_backlinksslug: StringResult<Vec<BacklinkInfo>, CommandError>Get all pages that link to the specified page (backlinks).
get_outgoing_linksslug: StringResult<Vec<OutgoingLinkInfo>, CommandError>Get all outgoing wiki-links from the specified page.
get_page_detailslug: StringResult<PageDetail, CommandError>Get complete page detail including metadata, word count, backlinks, and outgoing links.
rename_page_previewslug: String, new_title: StringResult<RenamePlan, CommandError>Preview a page rename operation without making changes.
rename_pageslug: String, new_title: StringResult<RenamedPageInfo, CommandError>Rename a page and update all links pointing to it.
save_block_contentslug: String, content_bytes: Vec<u8>, content_text: StringResult<(), CommandError>Save block content from binary LoroDoc bytes.
get_block_content_snapshotslug: StringResult<Vec<u8>, CommandError>Get the current block content as a LoroDoc snapshot (binary).
update_block_metadataslug: String, block_id: String, content_type: domain::BlockContentTypeResult<(), CommandError>Update block content-type metadata (scale, alignment, caption, etc.)
create_blockslug: String, content_type: domain::BlockContentType, position: u32Result<domain::Block, CommandError>Create a new typed block in a page at the specified slot position.
save_block_content_by_idslug: String, block_id: String, content_bytes: Vec<u8>, content_text: StringResult<(), CommandError>Save block content by block ID (for grid layout multi-editor).
get_block_content_snapshot_by_idslug: String, block_id: StringResult<Vec<u8>, CommandError>Get the current block content as a LoroDoc snapshot by block ID.
apply_layoutslug: String, layout_definition_id: StringResult<Page, CommandError>Apply a layout definition to a page.
remove_layoutslug: StringResult<(), CommandError>Remove the layout from a page.
create_block_in_areaslug: String, area: String, content_type: domain::BlockContentTypeResult<domain::Block, CommandError>Create a new block assigned to a named layout area.
assign_block_to_areaslug: String, block_id: String, area: Option<String>Result<(), CommandError>Assign or unassign a block to a named layout area.
check_links_resolutionslugs: Vec<String>Result<Vec<bool>, CommandError>Check which wiki-link slugs resolve to existing pages.
check_layout_compatibilityslug: String, layout_definition_id: StringResult<LayoutCompatibilityResult, CommandError>Check whether applying a layout definition would displace any blocks.

Presence

Source: apps/desktop/src-tauri/src/commands/presence.rs

CommandParametersReturn TypeDescription
get_active_participantsstate: 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

CommandParametersReturn TypeDescription
get_pending_suggestionsstate: State<'_, AppState>Result<Vec<ProactiveSuggestionDto>, CommandError>Get all pending (non-dismissed) proactive suggestions.
dismiss_suggestionstate: State<'_, AppState>, suggestion_id: StringResult<bool, CommandError>Dismiss a single proactive suggestion by ID.
dismiss_all_suggestionsstate: State<'_, AppState>Result<(), CommandError>Dismiss all proactive suggestions.

Property

Source: apps/desktop/src-tauri/src/commands/property.rs

CommandParametersReturn TypeDescription
list_propertiestype_id: Option<String>Result<Vec<PropertyDefinition>, CommandError>List all property definitions in the current workspace.
create_propertyname: String, value_type: String, description: Option<String>, config: Option<String>Result<PropertyDefinition, CommandError>Create a new property definition.
update_propertyid: String, name: Option<String>, description: Option<String>, config: Option<String>Result<PropertyDefinition, CommandError>Update an existing property definition.
delete_propertyid: StringResult<(), CommandError>Delete a property definition.

Property Value

Source: apps/desktop/src-tauri/src/commands/property_value.rs

CommandParametersReturn TypeDescription
get_page_propertiespage_id: StringResult<Vec<PagePropertyView>, CommandError>Get all property definitions and their current values for a page.
set_property_valuepage_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

CommandParametersReturn TypeDescription
list_recent_workspacesResult<Vec<RecentWorkspace>, CommandError>Get the list of recently opened workspaces.
add_to_recent_workspacesname: String, path: StringResult<(), CommandError>Add a workspace to the recent list.
remove_from_recent_workspacespath: StringResult<(), CommandError>Remove a workspace from the recent list.
clear_recent_workspacesResult<(), CommandError>Clear all recent workspaces.
refresh_recent_workspaces_menuResult<(), CommandError>Refresh the native Recent Workspaces menu.

Source: apps/desktop/src-tauri/src/commands/search.rs

CommandParametersReturn TypeDescription
search_pagesstate: 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

CommandParametersReturn TypeDescription
get_settingsResult<Settings, CommandError>Get the current application settings.
is_first_launchResult<bool, CommandError>Check if this is the first launch of the application.
complete_first_launchResult<(), CommandError>Mark the first launch tour as completed.
set_user_personapersona: UserPersonaResult<(), CommandError>Set the user’s persona during onboarding.
set_preferred_sign_in_methodmethod: SignInMethodResult<(), CommandError>Set the user’s preferred sign-in method.
analytics_opt_outResult<(), CommandError>Opt out of anonymous usage analytics.
analytics_opt_inResult<(), CommandError>Opt in to anonymous usage analytics.
analytics_is_opted_outResult<bool, CommandError>Check if analytics are opted out.
get_agent_settingsResult<Option<AgentSettings>, CommandError>Get the current agent settings.
update_agent_settingsagent_settings: AgentSettingsResult<(), CommandError>Update the agent settings.
set_api_keyprovider: AgentProvider, key: StringResult<(), CommandError>Store a provider API key in the OS keychain.
remove_api_keyprovider: AgentProviderResult<(), CommandError>Remove a provider API key from the OS keychain.
validate_api_keyprovider: AgentProvider, key: StringResult<ApiKeyValidationResult, CommandError>Validate a provider API key against the provider’s endpoint.

Skill

Source: apps/desktop/src-tauri/src/commands/skill.rs

CommandParametersReturn TypeDescription
list_skillsstate: State<'_, AppState>Result<Vec<SkillListItem>, CommandError>List all skills — composite of system skills (SkillRegistry) and
create_user_skillstate: State<'_, AppState>, id: String, name: String, description: String, system_template: StringResult<SkillListItem, CommandError>Create a new user-authored skill.
update_user_skillstate: State<'_, AppState>, id: String, name: String, description: String, system_template: StringResult<(), CommandError>Update an existing user skill by overwriting it.
delete_user_skillstate: State<'_, AppState>, id: StringResult<(), CommandError>Delete a user skill by ID. Idempotent — no error if the skill does not exist.
browse_marketplacestate: State<'_, AppState>Result<Vec<SkillListItem>, CommandError>Browse the locally cached marketplace skill catalogue.
install_marketplace_skillstate: State<'_, AppState>, id: String, name: String, description: String, system_template: StringResult<SkillListItem, CommandError>Install (cache locally) a skill from the marketplace.
list_execution_tracesstate: State<'_, AppState>, skill_id: String, limit: Option<u32>Result<Vec<ExecutionTraceDto>, CommandError>List execution traces for a given skill, most recent first.
get_execution_tracestate: State<'_, AppState>, id: StringResult<Option<ExecutionTraceDto>, CommandError>Get a specific execution trace by UUID.

Sync

Source: apps/desktop/src-tauri/src/commands/sync.rs

CommandParametersReturn TypeDescription
cloud_health_checkstate: State<'_, AppState>Result<String, CommandError>Verify connectivity to the cloud backend.
push_sync_queuestate: State<'_, AppState>, workspace_path: String, workspace_cloud_id: String, device_id: StringResult<PushSyncResult, CommandError>Manually flush the sync queue, pushing all pending block updates to Supabase.
store_auth_sessionstate: State<'_, AppState>, access_token: String, refresh_token: StringResult<(), CommandError>Store auth session tokens (access + refresh).
get_auth_sessionstate: State<'_, AppState>Result<Option<(String, String)>, CommandError>Retrieve stored auth session tokens.
clear_auth_sessionstate: State<'_, AppState>Result<(), CommandError>Clear stored auth session tokens.
register_devicestate: State<'_, AppState>, device_name: String, platform: StringResult<domain::Device, CommandError>Register a device with the Supabase backend.
list_devicesstate: State<'_, AppState>Result<Vec<domain::Device>, CommandError>List all devices registered to the current user.
deauthorize_devicestate: State<'_, AppState>, device_id: StringResult<(), CommandError>Deauthorize (delete) a device by its ID.
pull_sync_updatesstate: State<'_, AppState>, workspace_path: String, workspace_cloud_id: String, device_id: StringResult<PullSyncResult, CommandError>Pull remote block updates from Supabase and merge them locally.
start_syncworkspace_path: String, workspace_cloud_id: String, device_id: StringResult<(), CommandError>Start the background sync engine for the current workspace.
stop_syncResult<(), CommandError>Stop the background sync engine.
get_sync_statusstate: State<'_, AppState>Result<application::SyncStatus, CommandError>Get the current sync engine status.
trigger_pull_syncResult<(), CommandError>Trigger an immediate pull sync cycle via a realtime push notification.
force_syncResult<(), CommandError>Force an immediate sync cycle outside the normal interval.
push_page_metadatastate: State<'_, AppState>, workspace_cloud_id: String, device_id: String, fields: Vec<MetadataFieldInput>Result<PushMetadataCommandResult, CommandError>Push page metadata changes to the cloud.
pull_page_metadatastate: State<'_, AppState>, workspace_path: String, workspace_cloud_id: StringResult<PullMetadataCommandResult, CommandError>Pull page metadata from the cloud and apply LWW merge locally.
push_page_deletionstate: 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_deletionsstate: State<'_, AppState>, workspace_path: String, workspace_cloud_id: StringResult<PullDeletionsCommandResult, CommandError>Pull page deletion tombstones from the cloud and apply locally.
enable_workspace_syncstate: State<'_, AppState>Result<EnableSyncCommandResult, CommandError>Enable sync for the current workspace.
disable_workspace_syncResult<(), CommandError>Disable sync for the current workspace.
get_workspace_sync_statusResult<WorkspaceSyncStatusResult, CommandError>Get the sync status for the current workspace.
clone_cloud_workspacestate: State<'_, AppState>, cloud_id: String, workspace_name: StringResult<CloneWorkspaceResult, CommandError>Clone a cloud workspace to local storage.
list_cloud_workspacesstate: State<'_, AppState>Result<Vec<CloudWorkspaceInfo>, CommandError>List all cloud workspaces for the current user.

Tag

Source: apps/desktop/src-tauri/src/commands/tag.rs

CommandParametersReturn TypeDescription
create_tagname: String, color: Option<String>, group_id: Option<String>Result<Tag, CommandError>Create a new tag in the current workspace.
list_tagsResult<Vec<Tag>, CommandError>List all tags in the current workspace.
update_tagid: String, name: String, color: Option<String>, group_id: Option<String>Result<Tag, CommandError>Update an existing tag.
delete_tagid: StringResult<(), CommandError>Delete a tag by ID.
merge_tagssource_id: String, target_id: StringResult<u32, CommandError>Merge one tag into another, returning the number of pages updated.
search_tagsquery: String, limit: Option<usize>Result<Vec<Tag>, CommandError>Search tags by name prefix.
get_page_tagspage_id: StringResult<Vec<TagSummary>, CommandError>Get all tags associated with a page.
set_page_tagspage_id: String, tag_names: Vec<String>Result<(), CommandError>Replace all tags on a page atomically.
add_tag_to_pagepage_id: String, tag_id: StringResult<(), CommandError>Add a single tag to a page (no-op if already present).
remove_tag_from_pagepage_id: String, tag_id: StringResult<(), CommandError>Remove a single tag from a page.
create_tag_groupname: String, color: Option<String>Result<TagGroup, CommandError>Create a new tag group.
list_tag_groupsResult<Vec<TagGroup>, CommandError>List all tag groups in the current workspace.
update_tag_groupid: String, name: String, color: Option<String>, sort_order: i32Result<TagGroup, CommandError>Update an existing tag group.
delete_tag_groupid: StringResult<(), CommandError>Delete a tag group by ID.
filter_pages_by_tagstag_ids: Vec<String>, match_all: boolResult<Vec<String>, CommandError>Return page IDs that match the given tag filter.

Task Runner

Source: apps/desktop/src-tauri/src/commands/task_runner.rs

CommandParametersReturn TypeDescription
get_task_runner_healthResult<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

CommandParametersReturn TypeDescription
fetch_template_catalogstate: State<'_, AppState>Result<TemplateCatalog, CommandError>Fetch the cloud template catalog.
install_cloud_templatestate: State<'_, AppState>, file_path: StringResult<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

CommandParametersReturn TypeDescription
list_typesResult<Vec<TypeDefinition>, CommandError>List all type definitions in the current workspace.
create_typename: String, description: Option<String>, icon: Option<String>, icon_color: Option<String>Result<TypeDefinition, CommandError>Create a new type definition.
get_typeid: StringResult<TypeDefinition, CommandError>Get a type definition by ID.
update_typeid: 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_typeid: StringResult<(), CommandError>Delete a type definition.
add_property_to_typetype_id: String, property_id: StringResult<(), CommandError>Add a property to a type.
remove_property_from_typetype_id: String, property_id: StringResult<(), CommandError>Remove a property from a type.
assign_type_to_pagepage_id: String, type_id: StringResult<TypeAssignment, CommandError>Assign a type to a page (Manual scope).
remove_type_from_pagepage_id: String, type_id: StringResult<(), CommandError>Remove a type assignment from a page.
get_page_typespage_id: StringResult<Vec<TypeAssignment>, CommandError>Get all type assignments for a page.

Workspace

Source: apps/desktop/src-tauri/src/commands/workspace.rs

CommandParametersReturn TypeDescription
initialize_workspacepath: Option<String>, name: Option<String>Result<Workspace, CommandError>Initialize a workspace at the default location or specified path.
get_current_workspaceResult<Option<Workspace>, CommandError>Get the currently active workspace.
open_workspacepath: StringResult<Workspace, CommandError>Open an existing workspace at the specified path.
workspace_existspath: StringboolCheck if a workspace exists at the given path.
get_default_workspace_pathStringGet the default workspace path for the current environment.
get_workspaces_dirStringGet the workspaces directory for the current environment.
check_folder_statuspath: StringFolderStatusCheck the status of a folder for workspace creation.
rename_workspacenew_name: StringResult<RenameWorkspaceCommandResult, CommandError>Rename the current workspace.
reload_embedding_pipelineResult<(), CommandError>Reload the embedding pipeline for the current workspace.
close_workspaceResult<(), CommandError>Close the current workspace.
set_workspace_iconicon: Option<String>, icon_color: Option<String>Result<Workspace, CommandError>Set or change the icon for the current workspace.

Was this page helpful?