Appendix
FAQ, keyboard shortcuts reference, and glossary to help you better use MeshWork.
A. FAQ
Will private content be accidentally shared?
No. MeshWork protects your private content through clear data boundary design:
- Physical Isolation: Private libraries and shared spaces are completely independent directories in the file system. Private library content won't automatically appear in any shared space.
- Git Independence: Even when Git is enabled, private libraries and shared spaces use their own independent Git repositories or branches.
- Explicit Operations: Content enters shared boundaries only when you actively copy or move it from private library to shared space.
- Permission Control: Shared space remote repository access is managed by Git hosting platforms (like GitHub).
Keep personal notes, drafts, and unpublished ideas in your private library. Only publish organized, team-appropriate content to shared spaces.
How to handle Git conflicts?
Git conflicts usually occur when multiple people modify different versions of the same document simultaneously. When MeshWork cannot auto-merge changes, a conflict resolution interface pops up:
- Identify conflicts: The system automatically detects conflicting files and opens the conflict resolution interface.
- View differences: The interface lists all conflicting files on the left. After selecting a file, the main area displays local and remote version content side-by-side for easy comparison.
- Choose resolution: For each conflicting file, click the button below to choose the retention method:
- Keep local version: Retain your local modifications, discard remote version.
- Use remote version: Adopt remote version content, abandon local modifications.
- Keep both (local first): Merge both versions, local version content comes first.
- Keep both (remote first): Merge both versions, remote version content comes first.
- Preview results: After selection, the interface right side displays the final version preview after merging, you can confirm the result meets expectations.
- Apply resolution: After confirming correct, click "Apply". The system will write the resolved content to the document and mark the conflict as resolved.
Frequently pulling latest changes, timely pushing local modifications, and maintaining appropriate document granularity can all reduce conflict occurrences. In large teams, it's recommended to coordinate through discussion to avoid multiple people modifying the same document section simultaneously.
How to control AI assistant costs?
MeshWork provides multi-layer control mechanisms to manage AI assistant costs:
- Tool call count limits: In "Settings → AI", you can set the maximum number of tool calls an AI agent can make in a single reply. This prevents AI from generating unexpected costs through excessive searching or operations.
- Auto session duration: Set the default auto session duration in "Settings → AI" (default 2 minutes). Discussion Area topics can override this separately, inheriting the default when left blank.
- Model selection: Different models have different pricing and performance. For simple tasks, choose lower-cost models; for complex reasoning, choose more powerful models.
- Usage monitoring: Regularly check AI service usage statistics and bills to understand cost trends and adjust usage strategies.
API Keys are stored locally. Please ensure they won't be leaked. If you share your MeshWork configuration file or device with others, please remove API Keys first.
Multi-device usage considerations
When using MeshWork on multiple devices, please note the following:
- Data synchronization: MeshWork itself doesn't provide inter-device data synchronization services. You need to synchronize data through Git remote repositories or other synchronization mechanisms (such as iCloud Drive, Dropbox).
- Git configuration: Each device needs authentication that can access the remote repository. SSH uses a selected private key file or pasted private key content; HTTPS uses an access token.
- SSH keys: If using SSH to access remote repositories, each device needs to generate and add its own SSH key to GitHub.
- API Keys: AI service API Keys need to be configured separately on each device. Please be safe and don't transmit API Keys insecurely between devices.
- Workspace configuration: Workspace configuration (such as added shared space list) is stored locally and needs to be manually configured on each device.
- Simultaneous editing: Avoid editing the same document simultaneously on two devices without frequent synchronization, as this easily leads to Git conflicts.
When using multiple devices, develop the habit of pulling latest changes before starting work and pushing promptly after finishing work. This reduces conflicts and ensures data consistency across devices.
How to backup data?
MeshWork adopts a local-first design, all your data is stored on local disk. Here are several backup methods:
- Git remote repository: Configure Git remote repositories (such as GitHub) for private libraries and shared spaces. This is the simplest and most reliable backup method, also providing version history.
- Time Machine (macOS): Use macOS's built-in Time Machine to backup the entire disk, including MeshWork's data directory.
- Cloud storage sync: Put MeshWork's working directory in sync folders of cloud storage services like iCloud Drive, Dropbox, OneDrive. Note: This may increase Git conflict risks, use with caution.
- Manual copying: Regularly manually copy MeshWork's working directory to external storage devices or other locations.
Recommend using Git remote repositories as the primary backup method because it simultaneously provides version control, collaboration sharing, and history recovery capabilities. For particularly important content, combine with Time Machine for dual protection.
B. Keyboard Shortcuts
The following lists currently implemented keyboard shortcuts in MeshWork. The product is still under active development, and more shortcuts will be added in future versions.
Interface Operation Shortcuts
MeshWork provides the following keyboard shortcuts for interface operations:
| Shortcut | Function |
|---|---|
⌘ ⌥ S |
Toggle sidebar visibility |
⌘ ⌥ 0 |
Toggle AI assistant panel |
⌘ S |
Save current document |
⌘ E |
Toggle editor preview |
⌘ ⌥ E |
Toggle editor mode (source/WYSIWYG) |
Text Editing Shortcuts
In the document editor, MeshWork supports the following text formatting shortcuts:
| Shortcut | Function |
|---|---|
⌘ B |
Toggle bold formatting |
⌘ I |
Toggle italic formatting |
Font Size and Zoom Shortcuts
MeshWork supports focus-aware font size and zoom adjustment:
| Shortcut | Function |
|---|---|
⌘ = or ⌘ + |
Increase font size (editor focus) or zoom (preview focus) |
⌘ - |
Decrease font size (editor focus) or zoom (preview focus) |
⌘ 0 |
Reset font size (editor focus) or zoom (preview focus) |
Font size and zoom shortcuts automatically adjust based on current focus: when editor has focus, adjust editor font size; when preview area has focus, adjust preview zoom.
AI Conversation Shortcuts
In the AI assistant panel, you can use the following shortcuts and symbols:
| Shortcut/Symbol | Function |
|---|---|
@ (in input box) |
Trigger agent selection |
# (in input box) |
Trigger document reference |
/ (in input box) |
Trigger custom commands |
↩ (Enter) |
Send message |
⇧ ⌘ ↩ |
Force new AI session (ignore auto session) |
MeshWork follows macOS standard text editing shortcuts, such as ⌘ C (copy), ⌘ V (paste), ⌘ Z (undo), etc. These shortcuts all work normally in the application.
C. Glossary
- Workspace
- The main usage environment of MeshWork, a product and interaction layer concept, not a fixed disk directory or Git repository. The workspace is responsible for combining one private library and multiple shared spaces, providing a unified access entry.
- Private Library
- The data boundary belonging to the current user, suitable for storing personal long-term notes, research materials, writing drafts, inspiration fragments, and content that shouldn't automatically enter team sharing. It exists independently and doesn't belong to any shared space.
- Shared Space
- A team or project-level data boundary containing a public library, discussion area, shared attachments, and optionally its own Git history. Multiple users can collaborate through shared spaces.
- Public Library
- The part of a shared space for storing long-term knowledge, suitable for storing documents, project materials, and decision records maintained together by the team. Content in the Public Library automatically syncs to all members of that space.
- Discussion Area
- The place for daily communication and temporary communication in a shared space. Discussion Area content is conversational, suitable for quick communication, brainstorming, and immediate feedback.
- Agent
- An AI assistant configured with specific prompts and parameters. MeshWork supports multiple agents, each can have different expertise and behavior patterns. In conversations, specific agents can be selected through @ symbol.
- Auto Session Window
- Within a period of time (default 2 minutes) after sending a message to an AI agent, continued messages will automatically be sent to the same agent without needing to repeat @. This time window is called the auto session window.
- Topic
- A conversation thread in the Discussion Area. Each topic has a theme and a set of related messages. Topics help organize discussion content and prevent important information from being drowned in numerous messages.
- Topic Knowledge Card
- A structured card attached to one discussion topic that records the current summary, key points, decisions, open questions, and next steps. It coexists with the original message flow and uses Git history to preserve how the card evolved as the discussion progressed.
- Topic Branch
- A unique feature in MeshWork's Discussion Area that allows creating a new topic starting from any discussion message, achieving infinite extension and subdivision of dialogue. The new topic retains association with the original topic for traceability.
- Branch Isolation
- MeshWork uses Git branches to isolate data from different knowledge bases. Even if multiple knowledge bases use the same remote repository, they will bind to different branches without interfering with each other. This allows safely storing multiple related but independent knowledge bases in the same remote repository.
- Resource Directory
- The actual storage location on disk for a private library or shared space. The resource directory contains all data files including documents, discussions, and attachments.
- Git Commit
- A save point in Git version control, recording the state of files at a certain moment. MeshWork automatically creates commits at appropriate times, and you can also manually create commits to save important states.
- Git Push
- The operation of uploading local Git commits to a remote repository. After pushing, other team members can see your modifications.
- Git Pull
- The operation of fetching the latest changes from a remote repository and merging them into the local repository. Pulling lets you see other team members' latest modifications.
- Git Conflict
- A situation that occurs when Git cannot automatically merge two sets of modifications. Conflicts need to be manually resolved, choosing which content to keep.
- API Key
- A key used to access AI services (such as OpenAI, Anthropic Claude). You need to configure API Keys in MeshWork to use AI assistant functions.
- AI Provider
- AI service providers, such as OpenAI, Anthropic, Google, etc. MeshWork supports multiple providers, and you can choose according to your needs.
- Custom Command
- Quick commands that can be triggered via the / symbol in the document editor. You can customize commands to implement common functions, such as summarizing documents, extracting action items, etc.
- Markdown
- A lightweight markup language using simple text format to represent rich text format. MeshWork uses Markdown as the default document format.
- PlantUML
- A text-based diagram language commonly used for sequence diagrams, component diagrams, and technical architecture notes. MeshWork can render
plantumlandpumlcode blocks in Markdown preview and WYSIWYG editing. See the official PlantUML website for the full syntax. - Local-first
- A software architecture philosophy emphasizing that data is primarily stored on local devices, with cloud services as auxiliary and backup. MeshWork adopts a local-first design, ensuring you can use it normally even when offline.