marktext/marktext

Can another program use it through a documented, machine-readable surface?

• next: [desktop] L2 An automation interface: AppleScript, App Intents/Shortcuts, D-Bus, COM, IPC commands, or a local API. (no automation interface)

desktop ladder · level 1

• ✓ L1 Launchable by other programs with input: command-line arguments, a URL scheme or file associations. packages/desktop/src/main/cli/index.ts 1 matchpackages/desktop/src/main/cli/parser.ts 1 match
• ✗ L2 An automation interface: AppleScript, App Intents/Shortcuts, D-Bus, COM, IPC commands, or a local API. no automation interface
• ✓ L3 Its functions run without the GUI (a headless/batch mode or a companion CLI). packages/desktop/playwright.config.ts 1 match
• ✗ L4 The automation interface is specified machine-readably (an AppleScript sdef, D-Bus introspection XML, App Intents, an OpenAPI spec, MCP). no machine-readable automation contract

library ladder · level 4

• ✓ L1 An importable, packaged API exists. packages/desktop/package.json npm packagepackages/muya/package.json npm package
• ✓ L2 The public API is delimited (__all__, an exports map, exported identifiers). packages/desktop/package.json package entry pointpackages/muya/package.json package entry point
• ✓ L3 The public API is statically typed (py.typed, type declarations, a typed language). packages/desktop/package.json TypeScript typespackages/muya/package.json TypeScript types
• ✓ L4 An API reference is generated from the code (autodoc, mkdocstrings, typedoc, …). pnpm-lock.yaml 16 matches

Can integrators rely on it not changing under them?

• next: L2 A changelog exists and marks breaking changes. (no changelog)

all ladder · level 1

• ✓ L1 Releases are versioned (semver tags or versioned changelog sections). 57 semver tags, latest v0.21.2
• ✗ L2 A changelog exists and marks breaking changes. no changelog
• ✗ L3 A deprecation mechanism is used in code (warnings, @deprecated, Deprecation/Sunset headers) or the API is versioned. no deprecation mechanism or API versioning
• ✓ L4 Across tagged releases, no OpenAPI operation, CLI option or __all__ symbol was removed without first being deprecated. 20 tagged releases compared

Can others react to state changes without polling?

Can a machine act with its own revocable, least-privilege identity?

• next: [library] L4 Several profiles or scoped credentials per target. (no credential profiles)
• next: [desktop] L4 Several profiles or scoped credentials per target. (no credential profiles)

desktop ladder · level 3

• ✓ L1 Credentials are kept in the OS credential store (Keychain, Credential Manager, Secret Service), not in plain files. packages/desktop/src/main/dataCenter/index.ts 5 matchespackages/desktop/package.json 1 match
• ✓ L2 Automation and headless runs can authenticate without the GUI (credentials from the environment). packages/desktop/src/main/keyboard/shortcutHandler.ts 1 match
• ✓ L3 No output or log statement includes a credential. no credential in print/log statements
• ✗ L4 Several profiles or scoped credentials per target. no credential profiles

library ladder · level 3

• ✓ L1 Credentials can be supplied non-interactively (environment variables). packages/desktop/src/main/keyboard/shortcutHandler.ts 1 match
• ✓ L2 The credential environment variables are documented. packages/website/content/docs/end-user/ENVIRONMENT.md 1 match
• ✓ L3 No output or log statement includes a credential. no credential in print/log statements
• ✗ L4 Several profiles or scoped credentials per target. no credential profiles

Can its data get in and out, in bulk, in open formats, with an explicit schema?

Can an automated caller use it without guessing, and recover from failure?

• next: [library] L1 Errors are specific exception types, and library code never calls sys.exit. (no exception classes)
• next: [desktop] L3 Documented exit statuses distinguish error classes, and headless output is machine-readable (JSON). (exit statuses aren't documented)

desktop ladder · level 2

• ✓ L1 In headless mode, failures end with a non-zero exit status instead of a dialog. packages/muya/src/utils/diagram/sequence/sequence-diagram-snap.js 3 matchespackages/desktop/src/main/exceptionHandler.ts 2 matches
• ✓ L2 In headless mode, data goes to stdout and diagnostics to stderr. packages/desktop/src/renderer/src/store/editor.ts 12 matchespackages/desktop/src/renderer/src/prefComponents/image/components/uploader/index.vue 6 matches
• ✗ L3 Documented exit statuses distinguish error classes, and headless output is machine-readable (JSON). exit statuses aren't documented
• ✗ L4 Dry-run for side-effecting operations, and agent docs. no dry-run

library ladder · level 0

• ✗ L1 Errors are specific exception types, and library code never calls sys.exit. no exception classes
• ✓ L2 Inputs are validated with messages naming the bad argument. packages/muya/src/utils/diagram/sequence/sequence-diagram-snap.js 11 matchespackages/desktop/src/renderer/src/util/diagramExport.ts 6 matches
• ✓ L3 Timeouts and retries are configurable. packages/muya/src/utils/index.ts 4 matchespackages/muya/e2e/playwright.config.ts 3 matches
• ✓ L4 Agent docs, and examples that run as tests (doctests). AGENTS.mdpackages/muya/AGENTS.md

Can another system run and compose it without a human?

• next: [library] L3 Published to a public registry, with at most 10 runtime dependencies. (not published to a registry)
• next: [desktop] L4 Settings can be managed without the GUI: documented environment variables or config file, macOS defaults/MDM profiles, or Windows policies. (settings only change through the GUI)

desktop ladder · level 3

• ✓ L1 Buildable from source with documented steps (a README with commands). README.md
• ✓ L2 Packaged as an installer (dmg/pkg, MSI/MSIX, AppImage/Flatpak/Snap, electron-builder, Tauri bundle, PyInstaller). packages/desktop/electron-builder.ymlpnpm-lock.yaml 18 matches
• ✓ L3 Distributed for unattended installation: a package manager (Homebrew cask, winget, Chocolatey, Flathub, Snap) or release artifacts built in CI. .github/workflows/release.yml 2 matchesREADME.md 14 matches
• ✗ L4 Settings can be managed without the GUI: documented environment variables or config file, macOS defaults/MDM profiles, or Windows policies. settings only change through the GUI

library ladder · level 2

• ✓ L1 Importable from source. packages/desktop/package.json npm packagepackages/muya/package.json npm package
• ✓ L2 Installable as a package (a package manifest). packages/desktop/package.json package manifestpackages/muya/package.json package manifest
• ✗ L3 Published to a public registry, with at most 10 runtime dependencies. not published to a registry
• ✗ L4 Optional features behind extras/features. no optional extras

Can behaviour be added without modifying the code?

• next: L1 Internal seams: a registry, registration function or plugin manager. (no registry or registration function)

all ladder · level 0

• ✗ L1 Internal seams: a registry, registration function or plugin manager. no registry or registration function
• ✗ L2 The docs show how to add behaviour through those seams (even in-tree). no registration functions to document
• ✗ L3 Out-of-tree extensions are discovered (entry points, a plugin directory, configuration) without editing the package. extensions must be added inside the package
• ✗ L4 The extension API is versioned, has lifecycle hooks, and has example extensions. the extension API isn't versioned

Can an operator, or an orchestrating agent, tell whether it works and why not?

• next: [library] L3 Optional metrics or tracing hooks. (no metrics or tracing hooks)
• next: [desktop] L4 Tracing or metrics (OpenTelemetry). (no tracing)

desktop ladder · level 3

• ✓ L1 Writes logs through a standard logger (os_log/Logger, electron-log, logging, Qt categories). packages/desktop/src/main/app/index.ts 1 matchpackages/desktop/src/main/app/windowManager.ts 1 match
• ✓ L2 Log verbosity can be raised for diagnosis (--verbose/--debug, a log-level setting). packages/desktop/src/main/cli/parser.ts 3 matchespackages/desktop/src/main/utils/index.ts 3 matches
• ✓ L3 Crashes are reported (Sentry, Crashpad/Breakpad, Crashlytics, MetricKit). packages/desktop/src/main/exceptionHandler.ts 1 matchpackages/desktop/src/main/index.ts 1 match
• ✗ L4 Tracing or metrics (OpenTelemetry). no tracing

library ladder · level 2

• ✓ L1 Logs through a standard logger namespace and never prints from library code. packages/desktop/src/main/app/index.ts 1 matchpackages/desktop/src/main/app/windowManager.ts 1 match
• ✓ L2 Log levels are used meaningfully (at least two levels). levels: error, info, warn
• ✗ L3 Optional metrics or tracing hooks. no metrics or tracing hooks
• ✗ L4 OpenTelemetry instrumentation available. no OpenTelemetry instrumentation

Can an agent change it safely with limited context?

• next: L3 At least 90% of modules fit 32k tokens and no file exceeds 12k; test/source token ratio at least 0.3; at least 70% of the code is typed. (99% of modules fit 32k tokens; 6 files over 12k)

all ladder · level 2

• ✓ L1 A README and some tests. README.mdpackages/desktop/test/e2e/all-blocks-roundtrip.spec.ts 616 test files
• ✓ L2 CI runs the tests; applications pin dependencies (libraries and zero-dependency projects are exempt). .github/workflows/build.yml.github/workflows/e2e.yml
• ✗ L3 At least 90% of modules fit 32k tokens and no file exceeds 12k; test/source token ratio at least 0.3; at least 70% of the code is typed. 99% of modules fit 32k tokens; 6 files over 12k
• ✗ L4 No import cycles, and agent docs (AGENTS.md, CLAUDE.md, llms.txt). 4 import cycles (largest: packages/muya/src/block/base/content.ts, packages/muya/src/block/base/format.ts, packages/muya/src/block/base/parent.ts)