DevDesk complete user manual#
This is the beginner-first guide to DevDesk on Windows and Android. Read only the section you need. Every major tool also has a shorter focused manual linked from this page.
Make your project AI-ready—without giving up control.#
Give an MCP-compatible agent focused code, structure, and project knowledge instead of repeatedly sending the whole repository. DevDesk keeps the work inside the selected workspace and every write behind your review.
- Local-first
- Token-budgeted context
- Review before write
-
UnderstandMap stacks, code structure, files, and connected project knowledge.
-
ProposePrepare a complete multi-file change without writing directly.
-
You decideReview every file, choose trusted checks, apply, or use verified undo.
Your files stay yours. The connector is optional and uses your own compatible AI client.
Welcome to DevDesk#
DevDesk turns a normal folder into a workspace for plans, tasks, notes, connected knowledge, project files, API testing, and developer tools.
The main idea is simple:
Your folder remains the source of truth. DevDesk gives the same files useful views and tools without locking them into a DevDesk cloud.
DevDesk is useful for students, writers, project planners, researchers, and software developers. A beginner can start with tasks and notes. Technical tools stay optional.
Local-first and user-owned files#
Local-first means DevDesk works with data on your device before depending on an online service. Project Markdown, JSON, OpenAPI, and related files remain in the folder you choose.
You can open supported files in another editor. You can copy the folder, put appropriate files in Git, or back it up with your normal backup tool.
What DevDesk does not do#
- It does not upload your project folder to a DevDesk-operated cloud.
- It does not make every API request offline. Sending a request uses the network.
- It does not make a linked note true or verified.
- It does not run Git, scripts, or project commands merely because you opened a folder.
- It does not put protected secrets into portable project files by default.
- It does not replace a complete Git client. Verified Git actions are deliberately scoped.
Start Here: Your First Five Minutes#
Create a workspace#
- Open DevDesk.
- On Home, select New workspace.
- Choose a profile such as Personal plan, Study, Business project, Research / writing, Software project, or Blank.
- Enter a name such as
My First App Project. - Review the preview of folders and starter files.
- Choose the parent folder.
- Confirm creation.
What should appear: DevDesk opens the new workspace. The folder contains
project.devdesk and only the starter files shown in the preview.
If it does not appear: Check that the parent folder is writable. Choose a name that does not already exist. DevDesk will not silently replace an existing folder or file.
Create the first note#
- Select New.
- Select Note.
- Name it
Project overview. - Type one sentence describing the project.
- Save the note if the editor shows a Save action.
What should appear: The note is visible under Notes and Files.
Create the first task#
- Select New.
- Select Task.
- Type
Plan the first screen. - Choose a status, priority, or deadline only if you need one.
- Save the task.
What should appear: The task appears in Tasks and in compatible List, Board, Calendar, or Timeline views.
Find the files and reopen the workspace#
- Open Files.
- Select Open explorer when you need the advanced project tree.
- Note the folder containing
project.devdesk. - Close DevDesk.
- Reopen DevDesk and use Continue working, or open
project.devdesk.
On Windows, an installed build can associate project.devdesk with DevDesk.
On Android, select the folder that directly contains that file when the system
folder picker asks.
Choose What You Want to Do#
| I want to… | Start here |
|---|---|
| Plan a project | Tasks, then List or Board |
| Write notes | Notes, then Markdown basics |
| Connect knowledge | Add links, then open Relationships |
| Test an API | Quick API for one request or Saved API testing for saved work |
| Inspect JSON | JSON Tools |
| Edit a project text or source file | Open it from Files; use Open with → Compare only when you want a diff |
| Manage a developer project | New workspace > Software project |
| Move to another computer | Moving and Backing Up a Workspace |
| Learn every control | Home, workspace, and navigation |
Understanding a DevDesk Workspace#
A workspace is the folder you selected. It can contain normal files and subfolders. DevDesk adds views, search, relationships, and optional tools around those files.
Portable and device-local information#
| Information | Portable? | Notes |
|---|---|---|
| Markdown, JSON, OpenAPI, source files | Yes | Normal project-owned files |
project.devdesk |
Yes | Stable identity and safe relative settings |
Sanitized devdesk-api-workspace.json |
Yes | API structure without protected secrets |
| Graph positions and recent items | No | Personal device state |
| Tokens, cookies, execution trust | No | Protected local state |
project.devdesk does not contain absolute paths, passwords, commands, scripts,
recent files, or personal layout.
Safe folder locations#
- Choose a folder you can read and write.
- Keep a separate backup.
- Avoid placing the only copy on an unreliable removable drive.
- In a cloud-synced folder, let synchronization finish before editing the same file on another device.
- Keep secrets out of ordinary Markdown and JSON.
Moving or renaming a folder#
Copy or move the complete folder, including project.devdesk. Open the manifest
from the new location. Its stable project ID does not depend on the old absolute
path.
See Folders, portability, and scoped Git for the full boundary and recovery rules.
Choose the right workspace style#
You do not need to use every DevDesk feature. Start with the smallest workspace that helps you today, then add tools when the work becomes more technical.
Everyday planning, writing, or study#
Choose a profile such as Personal plan, Study, Business project, or Research / writing. Create tasks and ordinary Markdown notes first. Use List, Board, Calendar, Timeline, links, and graph views only when they make the same files easier to understand.
Software or developer work#
Choose Software project or open an existing folder. DevDesk can create or
open a portable project.devdesk file at the project root. That small JSON
file identifies the project and stores safe, relative settings. It does not
store absolute paths, credentials, shell commands, execution trust, or personal
screen layout.
From a project workspace, Developer tools can open the Markdown editor, workspace text editor, saved API testing, OpenAPI Studio, JSON tools, comparisons, scoped Git, and other tools with the current project already selected. If a tool needs a file, choose a compatible project file rather than copying it into a separate global workspace.
Share or move a project safely#
- Save the project files you want to keep.
- Include
project.devdeskwhen copying or committing the project. - Include
devdesk-api-workspace.jsononly when you want to share API structure; it deliberately excludes secrets and history. - On the next device, open
project.devdeskand then enter secrets locally. - Re-check folder permissions and any separate Git execution-trust prompt.
Opening a manifest is data-only. It does not run Git, project commands, hooks, API requests, AI tools, or a build.
Planning Your Work#
DevDesk can show the same underlying work in different views:
- List: a straightforward ordered view.
- Table: compares selected properties in compact rows.
- Cards: shows readable summaries in a responsive grid.
- Board: groups work by status.
- Calendar: places items with dates on a calendar.
- Timeline: shows work across time.
- Outline: shows hierarchy and structure.
- Map: shows only items with valid saved latitude and longitude.
- Relationships: shows links between items.
Table columns include title, type, status, tags, dates, path, and a built-in
read-only word count. View formulas cannot execute code. Personal saved views
stay on the device; a shared devdesk-views.json contains only the safe view
definition. See Structured workspace views.
A task is an action to complete. Status shows its current stage. Priority helps you decide what matters first. A deadline is the date by which work should be completed.
Beginner workflow#
- Create tasks with short action names.
- Add a deadline only when it is real.
- Use List while learning.
- Open Board when status groups help.
- Open Calendar or Timeline when dates matter.
- Change an item in one view.
- Confirm the same change appears in the other views.
The views should not create separate copies of the same task. If an item is missing from a date-based view, confirm that it has a valid date and that active filters are clear.
Visual brainstorming#
Open Visual Canvas to arrange text, file, link, and group nodes in a portable
.canvas file. Add labeled or directed connections, then use drag, pan, zoom,
fit, undo, and redo. The Canvas can remain independent or be saved to the
current workspace. Opening it never executes embedded code or URLs. See
Visual Canvas.
Markdown for Complete Beginners#
Markdown is plain text that uses small punctuation marks for formatting. DevDesk uses it because the file remains readable without DevDesk.
A small example#
Type:
# My Project
## Tasks
- [ ] Plan the project
- [ ] Build the first screen
- [x] Create the workspace
DevDesk displays a large title, a smaller Tasks heading, two empty checkboxes, and one completed checkbox.
Common formatting#
# Page title
## Section
**Bold**
*Italic*
- Bulleted item
1. Numbered item
> A quoted note
[DevDesk website](../index.html)

`inline code`
A code block uses three backticks before and after the code:
```json
{
"name": "DevDesk"
}
```
A table looks like this:
| Task | Status |
|---|---|
| Plan screen | Ready |
Create a Markdown file#
- Open Files.
- Select Open explorer.
- Open the destination folder.
- Select New file.
- Choose Markdown.
- Enter a safe file name.
- Write and save.
DevDesk adds the extension when needed and refuses names that would escape the workspace or replace an existing path.
For more examples, open Markdown basics.
Connecting Notes#
A link points from one note to another. A backlink is the automatic incoming view shown on the target note.
Standard link:
See the [API plan](api-plan.md).
Supported wiki-style link:
See [[API plan]].
Standard Markdown links are the most portable form.
Create a safe connection#
- Open the source note.
- Explain the relationship in a sentence.
- Insert a normal Markdown link.
- Save.
- Open the target note and inspect backlinks.
- Open Relationships to see the connection.
Broken links and renames#
A broken link points to a file that cannot be resolved. Check spelling, capitalization, spaces, and the relative path. When renaming a linked file, review incoming links and save every intended update.
Graph link editing changes only the active source note's managed connection block. Manual prose and links outside the block remain untouched. See Edit graph connections.
Properties and Metadata#
Metadata is small descriptive information about an item, such as its status, date, tags, or priority. It helps DevDesk filter and organize work.
Start with the visual Properties panel when available:
- Open a note or task.
- Open Properties.
- Add a tag such as
release. - Choose a status such as
draft. - Add a date or priority only when useful.
- Save.
Advanced users may see the same information as YAML frontmatter at the top of a Markdown file:
---
tags: [release, windows]
status: draft
priority: high
---
Frontmatter is a structured text block. It begins and ends with exactly three dashes. Use spaces, not tabs. See YAML frontmatter and properties.
Knowledge Graph#
A node is a Markdown file shown in the graph. A connection is a saved link between files.
The graph helps answer questions such as:
- Which notes explain this decision?
- What links to this API plan?
- Which notes are disconnected?
Open and use the graph#
- Open a workspace and select a Markdown note.
- Open Views > Relationships, or the focused graph from the Markdown tool.
- Choose Local for nearby notes or Workspace for a bounded project view.
- Pan by dragging the canvas.
- Zoom with +, -, touch, mouse, or trackpad.
- Select Fit view after changing the window or filters.
- Search or filter by title, path, type, or tag.
- Select a node to inspect or open its note.
- With keyboard focus on the graph, use arrow keys to select a nearby node, Enter to open it, and Escape to clear selection.
The header reports visible notes, links, and orphans. Open Options for the legend. When a filter produces no result, use the visible Clear filters action instead of rebuilding the project.
The graph reads saved Markdown links. It does not prove that a claim is correct. Node size does not mean truth or priority.
Missing or disconnected nodes#
- Save the note.
- Clear filters.
- Turn on Orphans.
- Select Fit view.
- Check the file is inside configured knowledge roots.
- Fix unresolved or ambiguous links.
- Refresh the project index when watching is unavailable.
Open Knowledge Format (OKF)#
OKF means Open Knowledge Format. In DevDesk, it is an optional way to make a folder of Markdown notes easier to browse, check, and move.
You do not need to learn OKF before using it. Your notes remain normal Markdown files that work in other editors.
An OKF bundle is the workspace folder. A concept is one Markdown file with a small YAML information block and a normal Markdown body.
Do I need OKF?#
Use it when you want consistent titles and types, folder indexes, source tracking, review status, or freshness reminders. Ignore it when ordinary notes already meet your needs.
Safest first-time workflow#
- Back up the workspace.
- Open Developer tools > Structure and OKF.
- Wait for Analyzing portable structured knowledge....
- Select Review safe fixes.
- Keep Project profile set to Software project for a normal software project.
- Keep Mark newly structured documents as draft enabled.
- Select Analyze and preview.
- Review every proposed file and reason.
- Select Apply reviewed plan only when the preview is correct.
What should appear: DevDesk adds or normalizes portable metadata and can create managed indexes. It preserves Markdown body text and unknown metadata.
Important: Analyze and preview does not immediately change files.
Create the first structured concept#
- Select Create concept.
- Choose Project documentation.
- Enter title
Release checklist. - Review the suggested path
concepts/release-checklist.md. - Add description
Checks the app before a public release. - Add tags
release, testing. - Keep status
draft. - Keep generated by
devdesk/1.0. - Leave advanced optional fields empty.
- Select Create.
What should appear: A normal Markdown file containing portable YAML frontmatter and starter headings. DevDesk does not replace an existing path.
Required rules#
For a normal concept, the current app requires:
- parseable YAML frontmatter;
- a non-empty
type.
Reserved index.md and log.md files follow their reserved structures when
present. Missing optional metadata, missing indexes, unknown types, and broken
links do not automatically make the bundle non-conformant.
Understand the findings#
- Required fixes: fix these first.
- Specification warnings: optional fields or structures need review.
- DevDesk recommendations: helpful but not required.
- Information: context that needs no change.
Import existing Markdown#
Open the existing folder as a workspace, then open Structure and OKF. DevDesk analyzes first. It does not need to rewrite files merely to inspect them.
The reviewed conversion can suggest a type, title, first-paragraph description, draft status, compatible v0.1 migration, indexes, and an optional update log. Existing Markdown bodies, unknown fields, custom index prose, and wiki links are preserved.
Manual advanced actions#
Use these only when the information is real:
- Record verification
- Add source
- Update lifecycle
- Preview indexes
- Add log entry
DevDesk never invents sources, human verification, lifecycle decisions, attestation results, trust conclusions, or computation results.
Recovery and read-only protection#
Managed plans store recovery information before writing. A changed file stops a stale plan. Partial verified writes can be rolled back, external edits are preserved, and a successful managed plan may remain undoable after restart.
Unknown future OKF versions and non-writable workspaces remain available for diagnostic analysis, but write actions are disabled.
See Structure checks (OKF), OKF bundle structure, OKF concepts and metadata, and Analyze, improve, and migrate project knowledge.
API Workspaces#
An API is a defined way for software to communicate. A request is the message you send. A response is the message returned.
Important words:
- URL: the destination address.
- Method: the intended action, such as GET or POST.
- Header: extra request information.
- Query parameter: a small value attached to the URL.
- Body: the main data sent with some requests.
- Status code: a number such as 200 or 404 describing the result.
Use Quick API for one temporary request. Use API Workspaces for saved collections, environments, protected values, assertions, and repeatable runs.
Safe public example#
- Open Quick API or create a saved request.
- Choose GET.
- Enter
https://jsonplaceholder.typicode.com/todos/1. - Do not add credentials.
- Select Send.
What should appear: A response status and a small JSON object.
If it fails: Check the URL, internet connection, VPN, proxy, TLS error, and
whether the public service is available. A 200 status does not by itself prove
that every returned value is correct.
Environments and secrets#
An environment stores target-specific values such as a development base URL. Use placeholders such as:
{{baseUrl}}/customers/{{customerId}}
Mark tokens, passwords, cookies, and credentials as protected secrets. Never place real credentials in screenshots, examples, ordinary notes, Git, or public support reports.
See Saved API testing and API environments and protected secrets.
Keep a saved API workspace with a project#
When you open Developer tools → API testing from a writable project,
DevDesk uses that project instead of silently mixing it with unrelated API
work. If needed, it creates devdesk-api-workspace.json beside
project.devdesk.
The project JSON can safely carry collections, request definitions, non-secret variables, environments, examples, assertions, extraction rules, and documentation. Protected values remain on the current device: tokens, passwords, cookies, OAuth credentials, request/response history, reports, proxy/TLS settings, and execution trust are not written into the portable file.
If Git, another editor, or another DevDesk window changes that JSON after you opened it, DevDesk stops the save rather than overwriting the external change. Reopen the project API file, review the current content, and then continue.
Project Text Editor#
Opening a supported project text or source file from Files now uses the
workspace text editor by default. Supported extensions include .txt, .log,
.xml, .html, .css, .js, .ts, .dart, .py, .java, .kt,
.swift, .sh, .bat, .env, .har, .bru, and .http. Markdown, JSON,
YAML, and OpenAPI keep their specialist tools. Binary files are not treated as
general text.
Ctrl+Sor Save workspace file writes only the active workspace-relative path with atomic, fingerprint-based conflict protection.Ctrl+Shift+Sor Save As exports an independent copy.- DevDesk warns before leaving with unsaved changes.
- Read-only workspaces can export a copy but cannot overwrite the project file.
- Save as Snippet stores app-managed snippet data rather than replacing the source file.
Copying all text uses likely-secret detection and conservative redaction.
Always review .env, HTTP, HAR, and source content yourself because automatic
redaction cannot identify every confidential value. Use Open with → Compare
when the goal is a deliberate difference rather than editing.
See Folders, portability, and scoped Git.
OpenAPI Studio#
OpenAPI is a standard description of an HTTP API. It lists endpoints, parameters, request bodies, responses, and schemas.
- Open OpenAPI Studio.
- Paste or open a supported Swagger 2.0, OpenAPI 3.0, or OpenAPI 3.1 JSON/YAML file.
- Select Validate and inspect.
- Review the title, version, endpoints, and schemas.
- Open validation messages and fix the source document.
- Choose Create collection only after review.
A schema describes the expected structure of data. Validation checks the document structure; it does not contact the server or prove that the API is safe.
Remote $ref files are not fetched automatically. Bundle required references
locally. See OpenAPI Studio.
JSON Tools#
JSON is a text format for structured data. An object uses curly braces and contains key/value pairs. An array uses square brackets and contains an ordered list.
{
"name": "DevDesk",
"status": "ready"
}
Here, name is a key and DevDesk is its value.
Format and validate JSON#
- Open JSON Tools.
- Paste or open the JSON.
- Select Format.
- Read any parsing error.
- Fix missing commas, quotes, or brackets.
- Copy or save only after reviewing sensitive data.
Minify removes unnecessary whitespace. It does not encrypt the data. See JSON Tools.
Git Tools#
Git records versions of files in a repository. A change is a file difference. A commit is a named saved checkpoint. A branch is a line of work. A diff shows what changed.
DevDesk deliberately restricts Git actions to the selected workspace, even when the real repository is a parent folder.
Verified DevDesk Git boundary#
- Opening
project.devdeskdoes not run Git or grant trust. - Source control needs a separate device-local trust decision.
- Status, diff, stage, unstage, and protected discard stay inside the workspace.
- A local commit is explicit, fingerprint-checked, and skips repository hooks.
- DevDesk does not fetch, pull, push, change remotes, run hooks, or manage credentials.
Beginner workflow#
- Back up important work.
- Open Developer tools > Source control on an eligible local Windows project.
- Grant local execution trust only after reviewing the displayed workspace folder. DevDesk runs no Git command before approval.
- If Git is missing, install Git for Windows and select Check again.
- If no repository exists, initialize only when the displayed workspace should
receive its own
.gitmetadata. Initialization does not stage or commit. - Review the repository root and displayed workspace scope.
- Open Changes and review a diff.
- Stage only the intended workspace path.
- Enter a commit message in DevDesk and select Commit staged files, or use your normal Git client after one more review.
Example in the workspace root:
git status
git diff --staged
git commit -m "Add first DevDesk project notes"
If the wrong file is staged, unstage it before committing. If Git is unavailable, confirm it is installed, the folder is inside the intended repository, and the workspace is an eligible local Windows folder.
What the scoped Git page can do#
The Windows Source Control page shows the real repository root separately from the DevDesk workspace scope. Changes provides inline or wide side-by-side text differences, explicit stage/unstage, bounded untracked-file preview, and recovery-patch-backed restore for a tracked working file. Untracked files are never deleted. History filters by commit message, author, or hash and shows the selected commit's workspace-scoped files and patch. Branches shows the current branch, upstream, ahead/behind counts, and remotes without fetching or changing them.
DevDesk creates local commits with --no-verify; it does not fetch, pull, push,
change remotes, run hooks, or manage Git credentials. A commit uses the
repository's staged index. For a workspace nested inside a parent repository,
confirm with your normal Git client that no unrelated parent files are already
staged before using the DevDesk commit action.
See Compare files and workspace-scoped Git.
Search, Navigation, and Shortcuts#
- Use Home search to find workspaces and tools.
- Use workspace Search for a quick filter.
- Use Developer tools > Search workspace for full indexed search.
- Use Files > Open explorer for nested folders and exact file selection.
- Press
/on this website to search the manual. - Use
TabandShift+Tabto move focus. - Use
EnterorSpaceto activate focused buttons. - Use
Escto close a focused panel where supported.
Editor shortcuts such as Ctrl+S depend on the active tool. Tooltips are the
authoritative local hint. See Keyboard shortcuts.
Connect an AI Agent#
The Windows and Android DevDesk Agent Connector lets an MCP-compatible client such as Codex or Gemini CLI request selected-workspace context. On Android, the client must run on the same device and DevDesk must remain open.
DevDesk does not include an AI provider or AI subscription. You bring your own client, account, API plan, or local model.
What the AI can learn#
- safe active-workspace metadata;
- bounded project paths, languages, roles, manifest signals, and detected stacks without file content;
- indexed document paths, titles, tags, and fingerprints;
- graph nodes, resolved written links, and backlinks;
- workspace issues and OKF status;
- redacted source, configuration, test, and Markdown text only when you enable Share redacted workspace text;
- a token-budgeted context pack combining relevant project snippets, detected stacks, and connected Markdown knowledge.
Nodes and links help an AI follow relevant written relationships. They do not prove that an answer is true or that two documents have an unstated semantic relationship.
Start and connect#
- Open a Windows or Android workspace.
- Open Settings > DevDesk Agent Connector.
- Review the optional permissions for text, proposals, verification, and scheduled read-only checks.
- Select Start connector.
- Copy the Codex or Gemini CLI configuration.
- Add it to the AI client's MCP settings.
- Ask the client to list DevDesk tools.
get_project_map is metadata-only. search_project_files searches paths,
languages, and roles while text sharing is off, and can also search redacted
content when it is on. read_project_file and build_context_pack require text
sharing. DevDesk skips generated folders, links, credential-like paths, binary
or non-UTF-8 files, and content beyond the enforced limits.
Review-only changes#
When Allow review proposals is on, an agent may queue a bounded, complete multi-file source, test, configuration, or Markdown change. It cannot approve or apply the change.
Open Review agent proposals, compare the current and proposed file, then choose Cancel, Reject, or Approve and apply. Approval uses a fingerprint and stops if the file changed after the agent read it.
The connector has no terminal, delete, approval, or Git-push tool. Stop it when you finish, and rotate its access key if an old configuration is no longer trusted.
Connected sessions are grouped by assigned workspace, with independent sessions shown separately. Each row reports the observed state, current safe tool, last activity, request count, in-flight work, permissions, and pending reviews. You can reassign only an idle session and DevDesk confirms the old and new scope. Concurrent reads are allowed; approved writes are serialized per workspace and fingerprint-checked again.
When Allow scheduled read-only checks is on, an agent can schedule or run a recurring graph-health check. The task records its plan, steps, result, retries, and next run locally. It cannot edit project files, runs only while DevDesk is open, and resumes overdue work after the app reopens.
See AI Agent Connector for exact Codex and Gemini CLI steps, tool names, troubleshooting, privacy, and official MCP references.
Moving and Backing Up a Workspace#
Copy to another computer#
- Save all open files.
- Close editors that may still write to the folder.
- Copy the complete folder, including
project.devdesk. - Use an external drive, private cloud-synced folder, or ZIP.
- Wait for the copy to finish.
- Compare file counts or inspect important files.
- On the other computer, open
project.devdesk. - Re-enter protected secrets locally.
Create a ZIP backup#
- Close DevDesk or finish saving.
- Create a ZIP of the complete workspace folder.
- Store it separately from the original.
- Open the ZIP and verify that
project.devdeskand important files exist. - Protect the ZIP if the project contains private data.
DevDesk's Settings backup covers supported private application records. It does not automatically include external project folders or protected secrets.
Export a Reinstall Recovery Kit#
Use a Recovery Kit for supported DevDesk-managed data and a sanitized list of external workspaces that you can reconnect after reinstalling:
Settings also shows Recovery readiness, including the last completed file export and the number of registered external workspaces. Open its Pre-uninstall checklist before removing the app.
- Open Settings > Data backup.
- Select Export Reinstall Recovery Kit and store the JSON somewhere safe.
- Back up each external workspace folder separately, such as with the ZIP steps above. The Recovery Kit does not contain those folders.
- After reinstalling, select Import Recovery Kit or Backup.
- Select Reconnect Recorded Workspaces, review the list, and then select Reconnect a workspace to choose the original folder. Repeat for the other recorded workspaces.
Version 3 kits contain the reconnection catalog. Older supported backups can still import but may not have one. The most recently imported kit replaces the stored reconnect list. Protected secrets, Android folder permission, execution trust, and Agent Connector access keys are not restored; grant or enter them again only when needed.
Avoid editing the same cloud-synced file on two devices at once. Resolve sync or Git conflicts before continuing. See Backup and restore.
Windows Guide#
Install#
- Open the official DevDesk Microsoft Store listing.
- Confirm the product name and publisher shown by Microsoft Store.
- Select Get or Install.
- Start DevDesk from the Start menu.
Update#
Microsoft Store can update apps automatically. You can also check from inside DevDesk:
- Open Settings.
- Scroll to About.
- Select Check for Updates.
- DevDesk compares the installed Windows build with the official Windows release record.
- When a newer build is available, select Update to open Microsoft Store.
The check reads only the small public release record. It does not upload your files, notes, credentials, or API requests, and DevDesk does not install an update automatically. If the check cannot connect, keep working and try again later. Microsoft Store Library is also available for manual update checks.
Files, windows, and keyboard#
- Double-clicking
project.devdeskworks when the installed package registered the file association. - A portable ZIP build cannot install that association.
- Resize or snap the window; optional side panels should collapse as space narrows.
- Use keyboard focus and shortcuts shown in tooltips.
Uninstall and data preservation#
Before uninstalling, export Settings > Data backup > Export Reinstall Recovery Kit, then back up every external workspace folder separately. Removing the app does not delete or preserve user-owned project folders for you. After reinstall, import the kit, reconnect each recorded folder, re-enter protected secrets, and grant trust again only after verifying the displayed path.
For an Android-to-Windows handoff, copy or sync the project folder separately,
reopen project.devdesk on Windows, and grant execution trust only after
checking the path. Android supports editing, graph, Canvas, context, and review;
local Git CLI actions and allowlisted project verification remain Windows
capabilities in this release.
Android Guide#
Android is currently in closed testing.
- Open the DevDesk support page.
- Contact the developer to request testing access.
- Use the Google account approved for the closed test.
- Install the Play-delivered build.
Do not post tester email addresses or credentials publicly.
Update Android#
Open Settings → About → Check for Updates. DevDesk compares the installed Android build with the official Android release record and opens Google Play when a newer build is available. An initial connection failure does not lock DevDesk; reconnect and try again later.
Folder access#
Android uses the system Storage Access Framework. When opening
project.devdesk, choose the folder that directly contains it and approve the
folder permission. If access is revoked, select the same folder again instead
of creating a duplicate workspace.
Phone, tablet, and resizable layouts#
- Phone portrait uses compact navigation and stacked content.
- Tablet or landscape can show more panels.
- Split-screen and freeform windows may collapse optional navigation.
- When the keyboard opens, scroll the focused field into view.
- At large text sizes, close optional panels and use a wider window when possible.
For transfer, export or copy the complete workspace through a provider that can preserve all files. Verify the destination before deleting the source.
Privacy and Security#
What stays local#
Project files remain in the selected folder. DevDesk can also keep device-local registry records, indexes, graph positions, drafts, recovery journals, recent state, permissions, and trust choices.
What may leave the device#
Only based on verified documented actions:
- API content goes to the destination you choose when you select Send.
- Supported GitHub comparison fetches the public URL/content you select.
- Link checks and external Store, support, privacy, or reference pages use the network.
- Android and Windows update checks read the public release record from the official DevDesk website. The installed comparison stays on your device.
- A connected AI client can receive the DevDesk tool results it requests. The client decides whether those results stay local or go to an AI provider.
The destination can receive normal connection information such as your public IP address.
Credentials and boundaries#
- Android uses a Keystore-backed local boundary where supported.
- Windows uses DPAPI for the current Windows user where supported.
- Protected values are excluded from supported portable exports and backups.
- Clipboard and exported files leave DevDesk's private storage boundary.
- A project manifest cannot grant command execution trust.
No analytics or tracking behavior is documented as part of the reviewed DevDesk product. See Privacy and security for the detailed boundary.
Troubleshooting#
Workspace does not open#
Confirm the folder and project.devdesk exist. On Android, reselect the folder
containing the manifest. On Windows, check permissions, removable-drive
availability, and security software. DevDesk does not overwrite corrupt or
future-version manifests automatically.
File cannot be saved#
Check write permission, invalid names, and whether another program changed the file. Choose a new name if the destination already exists. Preserve external edits and reopen before retrying.
Link does not work#
Check the relative path, extension, capitalization, spaces, and whether the target is inside the workspace.
Graph node is missing#
Save the note, clear filters, enable Orphans, select Fit view, and refresh the project index.
API request fails#
Check the final URL, method, network, environment, authentication, cookies, timeout, proxy, TLS, and server response.
JSON is invalid#
Look for a missing comma, unquoted key, unmatched bracket, invalid escape, or trailing text.
Git action is unavailable#
Use an eligible local Windows project, confirm Git is installed, review the workspace scope, and grant device-local trust only for the intended boundary.
External link does not open#
Check the default browser, internet connection, parental/enterprise policy, and popup protection. Copy the visible URL only when you trust the destination.
Android permission problem#
Open the system folder picker again and select the folder that directly contains
project.devdesk.
Windows Store update problem#
Open Microsoft Store, sign in if required, check Library/updates, restart the Store, and use Microsoft's Store troubleshooting guidance.
AI Agent Connector does not connect#
Keep DevDesk open, confirm the connector says Running, copy the current
configuration, and refresh MCP servers in the AI client. Another program may be
using port 45873. If the access key was rotated, remove the old URL.
Layout or text is too large#
Resize the window, close optional panels, use compact navigation, and scroll code examples horizontally. Keep the operating-system text size you need; do not reduce accessibility settings merely to reveal a broken layout.
Open Troubleshooting for more detailed recovery steps.
Glossary#
| Word | Simple meaning |
|---|---|
| API | A defined way for software to communicate |
| Backlink | An incoming reference from another note |
| Branch | A Git line of work |
| Commit | A named Git checkpoint |
| Frontmatter | YAML metadata at the top of a Markdown file |
| Git | A system that records file versions |
| JSON | A text format for structured data |
| Knowledge graph | A view of notes and their saved links |
| Local-first | Device and user-owned files are primary |
| Markdown | Plain text with lightweight formatting marks |
| Metadata | Descriptive fields such as tags, status, or date |
| Node | A note shown in the graph |
| OKF | Open Knowledge Format |
| OpenAPI | A standard description of an HTTP API |
| Repository | A folder whose history is managed by Git |
| Schema | Rules describing data structure |
| Workspace | The folder opened and managed in context |
Frequently Asked Questions#
Is DevDesk only for developers?#
No. Personal, Study, Business, and Research / writing profiles keep normal work first. Developer tools stay optional.
Does DevDesk upload my folder?#
No DevDesk-operated project upload or cloud sync is documented. Deliberate API requests and external links still use the network.
Can another editor read my notes?#
Yes. DevDesk uses ordinary Markdown and other normal project files.
Does removing a workspace delete its folder?#
No. It removes the private registration. Always verify the exact confirmation before any destructive operation.
Are backups encrypted?#
Treat exported backup JSON and workspace ZIPs as sensitive. Protected secrets are excluded from supported backups, but ordinary confidential content can remain.
Can DevDesk create Git commits?#
Yes, on an eligible local Windows project. The Git UI provides bounded status, diff, stage, unstage, protected discard, history, and an explicit local commit action. It skips hooks and does not fetch, pull, push, change remotes, or manage credentials. In a parent repository, verify that unrelated files are not already staged before committing.
Can DevDesk initialize a Git repository?#
Yes, for an eligible standalone local Windows workspace after you grant local
execution trust. DevDesk runs only git init during initialization; it does not
stage, commit, add a remote, or initialize a workspace already inside a parent
repository.
Can a Recovery Kit restore my workspace folders?#
No. It restores supported DevDesk-managed records and, in version 3, a sanitized catalog that helps you reconnect external workspace folders. Back up the folders themselves separately. Protected secrets, Android folder permission, execution trust, and Agent Connector access keys are intentionally excluded.
See the complete Frequently asked questions.
Learn More and References#
DevDesk's manual is sufficient for normal use. These optional official sources go deeper:
- CommonMark specification — Markdown syntax.
- RFC 8259 — JSON standard.
- RFC 9110 — HTTP semantics.
- OpenAPI Specification — API description standard.
- Git documentation — official Git reference.
- Microsoft Store app updates — Windows update help.
- Android Storage Access Framework — Android file and folder access.
- OKF v0.2 specification — the external OKF contract checked by DevDesk.
The first seven links describe general standards or platform behavior. The DevDesk manuals describe how this application uses those concepts.
Contact, Support, Downloads, and Microsoft Store#
- Download DevDesk
- Get DevDesk for Windows on Microsoft Store
- DevDesk support
- Privacy policy
- Android closed testing — contact the developer through the support page to join.
Never include tokens, passwords, private project files, or personal API data in a public support report.
Complete Beginner Walkthrough: My First App Project#
This tutorial combines planning, notes, links, properties, graph, API, JSON, Git, and backup without using real credentials.
1. Create the workspace#
- On Home, select New workspace.
- Choose Software project.
- Name it
My First App Project. - Review the exact preview.
- Choose a parent folder and create it.
Expected: The workspace opens and contains project.devdesk.
If missing: Check folder permission and whether a folder with that name already exists.
2. Create the project overview#
- Select New > Note.
- Name it
Project overview. - Type:
# My First App Project
This app helps me learn DevDesk.
## Goal
Create one small screen and document the work.
- Save.
Expected: The note appears under Notes and Files.
If missing: Clear search and check the workspace root in Files.
3. Create a task list#
- Create another note named
Tasks. - Type:
# Tasks
- [ ] Plan the screen
- [ ] Build the screen
- [ ] Test the screen
- [ ] Back up the workspace
- Save.
Expected: Four unchecked tasks appear in the rendered view.
If not: Confirm each line starts with - [ ].
4. Create and link two notes#
- Create
Design.mdwith a# Designheading. - Create
Testing.mdwith a# Testingheading. - In
Project overview, add:
Read the [design plan](Design.md) and [testing plan](Testing.md).
- Save all three notes.
Expected: The links open the target notes and backlinks appear.
If not: Check the file names and relative paths.
5. Add tags or properties#
- Open
Design.md. - Open Properties when available.
- Add tags
designandbeginner. - Set status to
draft. - Save.
Advanced text equivalent:
---
tags: [design, beginner]
status: draft
---
Expected: Properties or metadata show the saved values.
If not: Ensure frontmatter is the first block and uses spaces.
6. Open the knowledge graph#
- Open
Project overview. - Open Views > Relationships or the focused graph.
- Select Local.
- Select Fit view.
Expected: Project overview connects to Design and Testing.
If not: Save the files, clear filters, and refresh the project index.
7. Create a simple API request#
- Open Quick API.
- Choose GET.
- Enter
https://jsonplaceholder.typicode.com/todos/1. - Select Send.
Expected: A success status and a small response.
If not: Check network access and the final URL. Do not add credentials.
8. Inspect the JSON response#
- Copy the safe response body.
- Open JSON Tools.
- Paste the response.
- Select Format.
- Expand the tree when available.
Expected: Keys and values are indented and readable.
If not: Return to the Raw response and confirm you copied JSON rather than an HTML error page.
9. Create a safe Git checkpoint when Git is available#
- Open Developer tools > Source control on Windows.
- Review the displayed folder and grant local execution trust.
- If Git is missing, install Git for Windows and select Check again. If the
standalone tutorial folder is not a repository, select Initialize Git
repository only when you intend to add
.gitmetadata there. - Confirm the repository root and workspace boundaries.
- Open Changes, review each diff, and stage only the tutorial files.
- Enter a commit message and select Commit staged files. You can also use your normal Git client:
git diff --staged
git commit -m "Add My First App Project tutorial files"
Expected: Git records one commit containing only reviewed files.
If unavailable: Follow the page's trust, Git installation, or initialization guidance, or skip this optional step. Android provides a handoff to Windows instead of running a Git engine on the phone.
10. Back up the workspace#
- Save everything.
- Close active editors.
- Create a ZIP of the complete
My First App Projectfolder. - Open the ZIP and verify
project.devdesk,Project overview.md,Tasks.md,Design.md, andTesting.md.
Expected: The backup contains all tutorial files.
If not: Recreate the ZIP from the workspace folder, not from one selected file.
The ZIP is the project backup. To preserve supported DevDesk-managed records as well, also export Settings > Data backup > Export Reinstall Recovery Kit and store that JSON separately. The kit does not replace the ZIP.
11. Reopen and verify#
- Close DevDesk.
- Reopen
project.devdeskor select Continue working. - Open Project overview.
- Open the graph.
- Confirm the tasks, links, properties, and files are present.
Protected API secrets would need to be entered again on a different device. This tutorial deliberately used none.
