kition

<h1 align="center"> <a href="https://kition.ai"><img src="public/logo-mark.png" alt="Kition logo" width="64" valign="middle" /></a> Kition </h1> <p align="center"> <strong>English</strong> · <a href="README.zh-CN.md">简体中文</a> · <a href="README.ru-RU.md">Русский</a> · <a href="README.ja-JP.md">日本語</a> · <a href="README.vi-VN.md">Tiếng Việt</a> · <a href="README.fr-FR.md">Français</a> · <a href="README.de-DE.md">Deutsch</a> · <a href="README.es-ES.md">Español</a> </p> <p align="center"> <strong>Documents, Tables, Whiteboards, Agents, and Workflows in one desktop workspace.</strong><br /> Write connected knowledge, think visually, build data tools, research in the browser, and automate repeatable work. </p> <p align="center"> <a href="https://github.com/KitionAI/kition/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/KitionAI/kition/ci.yml?branch=main&amp;style=flat-square&amp;logo=githubactions&amp;logoColor=white&amp;label=CI" alt="CI status" /></a> <a href="https://github.com/KitionAI/kition/releases/latest"><img src="https://img.shields.io/github/v/release/KitionAI/kition?include_prereleases&amp;sort=semver&amp;style=flat-square&amp;color=5645d4" alt="Latest release" /></a> <a href="https://github.com/KitionAI/kition/releases"><img src="https://img.shields.io/github/downloads/KitionAI/kition/total?style=flat-square&amp;color=5645d4&amp;label=downloads" alt="Total GitHub release downloads" /></a> <a href="LICENSE"><img src="https://img.shields.io/github/license/KitionAI/kition?style=flat-square&amp;color=5645d4" alt="License: GNU AGPLv3" /></a> <img src="https://img.shields.io/badge/status-beta-f5d75e?style=flat-square" alt="Project status: beta" /> <img src="https://img.shields.io/badge/macOS-supported-5645d4?style=flat-square&amp;logo=apple&amp;logoColor=white" alt="macOS supported" /> <img src="https://img.shields.io/badge/Windows-supported-5645d4?style=flat-square&amp;logo=windows11&amp;logoColor=white" alt="Windows supported" /> <img src="https://img.shields.io/badge/Linux-experimental-f5d75e?style=flat-square&amp;logo=linux&amp;logoColor=111827" alt="Linux experimental" /> </p> <h3 align="center"><a href="https://github.com/KitionAI/kition/releases/latest"><ins>Download Kition</ins></a></h3> <p align="center"> <a href="https://kition.ai">Website</a> · <a href="https://github.com/KitionAI/kition/releases">Releases</a> · <a href="https://github.com/KitionAI/kition/discussions">Discussions</a> · <a href="CONTRIBUTING.md">Contributing</a> · <a href=".github/SUPPORT.md">Support</a> · <a href=".github/SECURITY.md">Security</a> </p> <p align="center"> <img src="docs/readme/kition-overview.webp" alt="Kition product overview showing documents, structured data tables, the dark Whiteboard workspace, Agent research, and visual workflows" width="100%" /> </p> Kition brings Markdown documents, structured table files, an infinite Whiteboard, a tool-using AI agent, browser research, and visual workflows into one desktop workspace. Instead of making every task begin in a blank chat, Kition gives the Agent editable project files, typed records, attachments, and visible processes to work with. This makes powerful AI operations easier to inspect, correct, and repeat without handing context between disconnected tools. > Kition is currently in beta. Back up important workspaces and review agent > changes before relying on them in production workflows. ## Why Kition - **Connected documents.** Write Markdown with live preview, links, backlinks, callouts, code, math, diagrams, daily notes, search, and export. - **Structured data beside the knowledge.** Turn research and content into typed records, formulas, filters, groups, views, attachments, and AI fields. - **Visual thinking with reviewable AI changes.** Build diagrams, mind maps, flows, and freeform sketches, then review Agent proposals before applying them to the Whiteboard. - **An Agent that can act.** Research in browser tabs, inspect documents and table schemas, update content, and save useful output into the active project. - **Reviewable document edits.** Let the Agent edit the active document, inspect every addition and deletion, then accept or reject individual changes. - **Visible automation.** Assemble trigger-and-action workflows, test steps, inspect run history, and resolve missing inputs before enabling a process. ## Let the Agent Edit—Keep the Final Say Instead of returning another suggestion to copy and paste, the Kition Agent can read the active Markdown document, make scoped changes, and write the result back into the workspace. The document and the complete task trace remain visible together while the Agent works. <p align="center"> <img src="docs/readme/agent-document-edit.webp" alt="Kition open source AI Agent reading and editing the active Markdown document beside a visible tool execution trace" width="100%" /> </p> When a file changes outside the editor, Kition opens a document review surface that highlights additions, deletions, and rewrites. Each change can be accepted or rejected individually, or the complete edit can be reviewed as one set. <p align="center"> <img src="docs/readme/agent-document-diff-review.webp" alt="Kition document diff review showing AI additions and deletions with controls to accept or reject each change" width="100%" /> </p> This creates a controlled document workflow: describe the goal in natural language, let the Agent edit the real file, inspect the diff, and decide exactly what remains in the final document. ## Start With Work, Not a Blank Prompt A capable Agent is useful, but a blank prompt still asks the user to design the task, describe every input, choose an output format, and recover when a step goes wrong. Kition moves that complexity into familiar work surfaces: documents, table fields, records, templates, and workflows. The built-in scenarios below are ordinary `.kitable` files. Their prompts, field relationships, generated assets, and review states stay visible and can be adapted to a real project. ### Generate campaign assets in batches Start with a key message and a face photo. Typed fields keep the content type and intended emotion explicit, while AI fields generate linked 16:9 and 9:16 thumbnail variants for every record. The table becomes both the batch queue and the review surface. <p align="center"> <img src="docs/readme/scenarios/thumbnail-generator.webp" alt="Kition table generating 16:9 and 9:16 video thumbnails from messages, portraits, content types, and emotions" width="100%" /> </p> ### Turn receipt images into searchable records Drop receipt photos into an attachment field. Vision-powered fields extract the vendor, address, category, structured JSON, and plain OCR text directly into the same row. The results can then be filtered, corrected, summarized by the Agent, or passed into a review workflow. <p align="center"> <img src="docs/readme/scenarios/receipt-ocr.webp" alt="Kition receipt OCR table extracting vendor, address, category, structured data, and plain text from images" width="100%" /> </p> ### Expand one product brief into a complete asset pipeline One product concept can drive multiple design candidates, orthographic views, a feature image, a lifestyle shot, a style board, and launch copy. Each result remains attached to the source record, so the full chain is easier to compare, regenerate, and hand off than a collection of disconnected chat outputs. <p align="center"> <img src="docs/readme/scenarios/batch-product-designer.webp" alt="Kition batch product design table with generated designs, orthographic views, feature images, lifestyle shots, style boards, and launch copy" width="100%" /> </p> ### Design posters from records, Boards, and the Agent Design Studio turns a table record, a Board frame, or a generated image into an editable poster. Templates bind the workspace brand kit, size variants keep one composition across poster, story, square, and landscape, and the Agent proposes text and layout changes as a reviewable preview. Exports go back into documents and tables. See [docs/design-studio.md](docs/design-studio.md). <p align="center"> <img src="docs/readme/design-studio.webp" alt="Kition Design Studio editing a poster with an Agent preview, size variants, and a brand kit" width="100%" /> </p> These scenarios show the intended Kition loop: use documents for narrative context, tables for structured state, Whiteboards for visual thinking, the Agent for uncertain work, and Workflows for steps that should become repeatable. ## Product Tour <table> <tr> <td width="42%" valign="middle"> ### Write connected documents Write Markdown with live preview, internal links, backlinks, tags, outlines, embeds, callouts, code, math, diagrams, templates, daily notes, tabs, and full-text search. Export finished work to PDF or DOCX when it needs to leave the workspace. </td> <td width="58%"> <img src="docs/readme/documents.webp" alt="Kition document editor showing Markdown content and workspace navigation" width="100%" /> </td> </tr> <tr> <td width="58%"> <img src="docs/readme/tables.webp" alt="Kition structured table with typed fields, views, filters, and record controls" width="100%" /> </td> <td width="42%" valign="middle"> ### Turn data into useful tools Create structured table files with typed fields, attachments, formulas, filters, sorting, grouping, multiple views, and fast record editing. Use them for research, content pipelines, lightweight CRM, inventory, or project tracking. </td> </tr> <tr> <td width="42%" valign="middle"> ### Give the agent real context Ask the Kition agent to read and update documents, inspect table schemas, create or modify records, research in browser tabs, use tools, and follow a plan. Agent output can be written back into the active workspace. </td> <td width="58%"> <img src="docs/readme/agent.webp" alt="Kition Agent working beside a document and saving a result into the workspace" width="100%" /> </td> </tr> <tr> <td width="58%"> <img src="docs/readme/whiteboards.webp" alt="Kition dark Whiteboard workspace with connected nodes, a selected launch strategy, style controls, and drawing tools" width="100%" /> </td> <td width="42%" valign="middle"> ### Think and plan visually Build diagrams, mind maps, flowcharts, sticky-note clusters, and freeform sketches on an infinite canvas. The Agent can inspect the board, propose typed changes, and let you accept or reject the preview before it becomes part of the workspace. </td> </tr> <tr> <td width="42%" valign="middle"> ### Automate repeatable work Build trigger-and-action workflows on a visual canvas. Start from a template, assemble a workflow manually, test individual steps, inspect run history, and resolve missing inputs before enabling it. </td> <td width="58%"> <img src="docs/readme/workflows.webp" alt="Kition visual workflow canvas with a trigger, action, configuration, and test controls" width="100%" /> </td> </tr> </table> Also included: - AI-assisted table fields for generating text, structured values, and media from record context. - Browser research tabs that stay inside the workspace and can be used by the agent when a task needs live web context. - Email connections and inbox-to-table workflows. See [Email Connections](docs/email-connections.md). - Model, proxy, MCP, account, usage, update, and desktop integration settings. - A seeded Getting Started workspace with practical document, table, and workflow examples. ## Install Desktop builds are published through [GitHub Releases](https://github.com/KitionAI/kition/releases/latest). - **macOS:** download the latest `.dmg`. - **Windows:** download the latest installer. - **Linux (experimental):** download the latest x86_64 `.AppImage`. - **Previous versions:** browse the complete [release history](https://github.com/KitionAI/kition/releases). ## Run From Source Requirements: - Node.js 22.19.0 - pnpm 10.33.0 ```bash pnpm install --frozen-lockfile pnpm dev ``` `pnpm dev` verifies and caches the pinned released runtime outside the Git worktree, then starts the Electron client. For renderer, component, editor, and style work that does not require runtime integration: ```bash pnpm dev:web ``` The web preview runs without the private runtime and is the fastest path for most client-side contributions. More options are documented in [Runtime development](docs/runtime-development.md). ## Open Source Boundary This repository contains the public React and Electron client: - document, table, Whiteboard, Agent, browser, settings, email, scenario, and workflow UI; - the Electron shell and desktop integration; - public runtime contracts, mocks, fixtures, and black-box tests; - packaging and unified release workflows. The Kition runtime is maintained separately and its source is not included in this repository. Released desktop builds pair the public client with a signed runtime. Source checkouts communicate with it only through the public contracts in [`contracts/runtime/`](contracts/runtime/). There is no Go source, Go module, or runtime source-build fallback in this repository. ## Technology | Area | Stack | | --- | --- | | Desktop | Electron | | Interface | React, TypeScript, Vite | | Documents | CodeMirror, Marked, Mermaid, KaTeX | | Data and state | IndexedDB, Jotai, Zod | | Testing | Vitest, Playwright | ## Contributing Issues and pull requests for the public client are welcome. 1. Read [CONTRIBUTING.md](CONTRIBUTING.md) for setup, scope, and required checks. 2. Follow the [Kition Development Standard](docs/development-standard.md), including the recommended Orca worktree workflow. 3. Keep changes inside the public client/runtime contract boundary. 4. Report security-sensitive issues through [.github/SECURITY.md](.github/SECURITY.md), not a public issue. For product questions, account help, and private workspace concerns, see [.github/SUPPORT.md](.github/SUPPORT.md). ## Repository Layout ```text . ├── .github/ # Community health files and CI workflows ├── contracts/runtime/ # Public runtime schemas ├── docs/ # Product, contributor, design, and runtime docs ├── e2e/ # Playwright black-box tests ├── electron/ # Electron shell and runtime manager ├── public/ # Static assets and onboarding files ├── scripts/ # Repository checks and inspection entry points ├── src/ # React application organized by feature domain ├── tooling/ # Build, lint, and test configuration └── package.json # Development, test, and packaging commands ``` ## License The Kition public client is licensed under the [GNU Affero General Public License v3.0 only](LICENSE). The separately distributed Kition runtime is governed by its own license and is not included in this repository.