clin-rs

reekta92GPL-3.0活跃维护

用 Rust 写的终端笔记管理应用,借鉴 Obsidian 的双链和 Markdown 笔记思路,在命令行里就能整理和浏览笔记。

Feature-packed TUI note management app inspired by Obsidian

v0.14.1发布于 2026-11-06 19:50 UTC587star +8 / 7 天18fork同步于 2026-11-11 05:53 UTC

怎么上手

由 README 提炼,执行前请确认
cargo install clin-rs --locked
clin --vault /path/to/vault
硬件要求按 README 说明

README 未说明硬件要求;需现代终端,原生图片渲染取决于终端支持,Nerd Fonts 可选

支持 Apple Silicon
下载:源码 zip·GitHub Releases(安装包)本站不镜像安装包

项目说明

由 README 自动翻译提炼

终端里的 Obsidian 式 Markdown 笔记管理器,写、连、整理、排期一站完成

用 Rust 写的终端笔记管理应用,借鉴 Obsidian 的双链和 Markdown 笔记思路,在命令行里就能整理和浏览笔记。

核心能力

  • 用 TUI 浏览、搜索、标签、置顶并预览编辑 Markdown 笔记
  • 用 wikilink 力导向图实时探索笔记间关联
  • 兼容 Obsidian 的 .canvas 画布与 .base 数据库视图
  • 日历支持 iCal 导入导出与 CalDAV 手动同步
  • 用盲文字符做自由手绘并支持形状、文字、缩放

容易踩的坑

从源码安装需 Rust 1.90.0+;新版本改用明文存储,不再提供加密与备份,加密仓库需先用旧版解密;macOS 无 Intel 预编译包,Nix 需启用 flakes

内容由模型根据 README 生成,可能不完整或不准确,以官方文档为准。看原文 README

最近发版

5 个版本v0.14.1
  1. v0.14.1最新正式版2026-11-06 · 2026-11-06 19:50 UTC

    Changelog

    All notable changes to clin are documented in this file.

    [0.14.1] - 2026-11-06

    Fixed

    • Use GitHub token for wiki sync (#260)
    • Set 60hz render limit (#259)
  2. v0.14.0v0.14.0 Bases, Calendar, Feature Toggles and more2026-11-06 · 2026-11-06 14:39 UTC
    查看更新说明

    TLDR:

    Clin gains native Bases, a full Calendar with CalDAV sync, broader Mermaid previews, and a command palette available across views. Saving, recovery, imports, and background processing receive substantial improvements. Built-in encryption and Git backup are removed; encrypted vaults require preparation before upgrading.

    ADDED:

    • Native Bases - Open .base files in Table, List, Cards, and Kanban layouts, with typed properties, formulas, filters, sorting, grouping, summaries, search, and export.
    • Bases authoring and live embeds - Create and configure Bases, edit properties, move cards, display image covers, and embed live views in Markdown and Canvas, with guarded undo/redo.
    • Calendar - Manage recurring events in Month, Week, Day, and Agenda views, link notes, use inline references, import/export iCalendar files, and manually synchronize CalDAV calendars with conflict resolution.
    • Global command palette - Access contextual actions across views with Ctrl+Space or F6, including guarded navigation, save, and quit commands.
    • Frontmatter editor - Press F7 to edit structured properties or raw YAML, with configurable automatic metadata output.
    • Mermaid previews - Render flowcharts, sequence diagrams, entity relationship diagrams, and state diagrams inline. Toggle editor diagram previews with Alt+m.
    • New layouts - For notes view, added multi and list layouts that are similar to tree layout, can be switched to via command palette.
    • Folder-local template variables - Define variables in .clin-template.toml, with inheritance, folder-specific overrides, and editable folder configuration.
    • Feature controls - Manage supported features through a central [features] configuration with enabled, disabled, and deleted states.
    • Setup options - Choose the Notes layout and feature preset during setup.
    • Icons and folder badges - Use Emoji icon mode, distinct file-type icons, and folder configuration badges.
    • Selection counts - See word and character counts for selected editor text.
    • CLI note creation options - Create notes in a destination folder with --folder and read content using --stdin or automatically detected piped input.
    • Lots of UI improvements - Several UI improvements across the project; sections are spaced more thoughtfully, all the icons got refurbished, colorful sections where revelant and more.
    • Standalone draw-rs - Draw view is now a standalone project acting as a library for clin-rs, you can download and use it from it's repository draw-rs.

    CHANGED:

    • Palette workflows now keep selectors, settings, creation forms, and other supported inputs inside the palette. Actions support previews, category colors, and persistent frequency/recency ranking.
    • Notes layouts share section behavior and optional Vault, Pinned, Smart, and Subnotes header tabs.
    • Headers, footers, popups, selectors, and pane styling follow more consistent theme and sizing rules.
    • Drawing now uses the standalone draw-rs engine through a Clin adapter.
    • Static views redraw only when needed. Preview loading, image processing, catalog updates, and Calendar queries use bounded background work with cancellation.
    • Legacy feature flags migrate into [features]; newly generated configurations enable all supported features by default.
    • HTML URL imports can use optional trafilatura article extraction, with fallback to existing converters.

    FIXED:

    • Note, public-document, Drawing, and Canvas saves now use shared conflict checks and guarded writes to reduce accidental overwrites.
    • Failed saves and recovery conflicts retain unsaved content. Recovery leaves records owned by another active session untouched.
    • Vault migration preserves attachments, hidden metadata, templates, subnotes, recovery records, and vault-relative paths.
    • Folder operations, attachment access, and public-document
  3. v0.13.22026-10-02 · 2026-10-02 12:05 UTC
    查看更新说明

    Changelog

    All notable changes to clin are documented in this file.

    [0.13.2] - 2026-10-02

    Fixed

    • Align table delimiter row and fix cell truncation

    Miscellaneous

    • Fix remaining negated assert_is_empty lints
    • Fix clippy assert_is_empty and update yoke-derive to resolve cargo deny

    Styling

    • Cargo fmt
  4. v0.13.12026-09-29 · 2026-09-29 13:40 UTC
    查看更新说明

    Changelog

    All notable changes to clin are documented in this file.

    [0.13.1] - 2026-09-29

    Fixed

    • Pop kitty flags on suspend and re-push on resume
    • Fallback to default 'origin' for auto_push when remote_name is absent

    Miscellaneous

    • ROADMAP update

    Styling

    • Fix clippy warnings in backup tests
  5. v0.13.0v0.13.0 multiple vaults, edit mode improvements2026-09-23 · 2026-09-23 14:34 UTC
    查看更新说明

    Mainly focused on the new modular view system via graf-rs and pinstar as libraries and using src/pinstar_adapter.rs, src/graf_adapter.rs helpers. This change has been made for easier managing of the said repositories as well as reducing the load on the clin-rs and for possible plugin system for custom views in the future.

    ADDED

    • Multiple vaults that can be accessed via overlay invoked with F5 or via config, each vault can also be given names. Request #151
    • Zen mode in edit view that focuses text at the center strips visual distractions and with toggleble dimming. Request #155
    • Text alignment in edit view, you can now change the alignment of the text to left, right, center and justified via F8 key.
    • graf update, bumped to graf v1.0.1 which adds features focused on node rendering like node_scale, better text rendering and more, check graf-rs for more details.

    FIXED

    • Fixed issues #165 #168 #157 #152
    • Fixed grep search not automatically activating in the search popup at notes view.

用户点评

登录用户的真实使用记录,可按版本和硬件筛选
共 0 条

    还没有人点评。第一个说出真实体验的人最有价值。

    README 原文

    未翻译

    clin

    Your Markdown vault, in your terminal.

    A free, open-source note manager inspired by Obsidian, built in Rust. Write, connect, organize, and schedule notes in one terminal app.

    GitHub release CI last commit License: GPL-3.0

    Features · Install · Quick start · Wiki

    Screenshots

    Features

    WorkflowWhat you can doGuide
    Notes & editorBrowse folders, search, tag, pin, and edit Markdown with previews, wikilinks, and an external editor.Notes · Editor
    GraphExplore connections between notes through an interactive, force-directed wikilink graph.Graph
    CanvasArrange text, files, links, and images on an infinite canvas using Obsidian's .canvas format.Canvas
    BasesQuery and organize note properties in tables, lists, cards, and Kanban layouts.Bases
    CalendarSchedule linked notes, switch month/week/day/agenda views, import/export iCalendar, and sync manually with CalDAV.Calendar
    DrawingSketch freehand, add shapes and text, and pan or zoom your drawings.Draw
    ThemesChoose from 19 built-in themes or supply a custom TOML theme; customize colors, icons, and status lines.Themes

    Also includes templates, outlines, subnotes, daily writing goals, and file/URL imports with optional conversion and OCR tools.

    Installation

    Download a package from Releases, or use your preferred package manager:

    PlatformInstall
    Linux, Windows, macOS (from source)cargo install clin-rs --locked — Rust 1.90.0+
    Arch Linuxyay -S clin-rs-bin
    Nixnix run github:reekta92/clin-rs — flakes enabled
    Debian / Ubuntu.deb for amd64 or arm64
    Fedora / RHEL.rpm for x86_64 or aarch64
    Other LinuxArchives for x86_64/aarch64; AppImage for x86_64
    Windowsx86_64 .zip
    macOSApple Silicon .dmg or archive; no Intel prebuilt binary

    See the installation guide for platform commands, source builds, and optional tools. A modern terminal is recommended; native images depend on terminal support. Nerd Fonts are optional: use Unicode, emoji, or text-only icons with a regular font.

    Upgrading an encrypted vault? This release uses plaintext and no longer provides encryption or backups. Preserve your originals and keys; use the previous release to decrypt notes and recover legacy drafts. Read Upgrading first.

    Quick start

    clin                                         # Launch; first run opens setup
    clin --vault /path/to/vault                   # Open an existing vault
    clin notes quick "Meeting notes" "Standup"    # Save a note without opening the TUI
    

    With the default keybind preset:

    KeyAction
    j / k, arrowsMove through the notes list
    EnterOpen the selected note
    Ctrl+Space / F6Open the contextual command palette
    Ctrl+GOpen the graph from Notes
    ? / F1Open help from Notes
    F2Show current keybindings
    F4Switch vaults

    Use setup to choose your layout, features, appearance, and keybind preset. Open an existing Obsidian vault for Markdown, Canvas, and Bases workflows; Obsidian plugins are not executed. Review Canvas and Bases compatibility before relying on those workflows.

    CLI commands

    Run clin --help or clin notes --help to discover commands. The CLI guide covers note creation, shell input, templates, vault management, configuration, and cache commands.

    Documentation

    Browse the Wiki for all guides, or the repository documentation index.

    The Wiki syncs from main; documentation changes belong in the repository source files.

    Support & credits

    Support development on Patreon. Licensed under GPL-3.0.

    Built with Ratatui, Crossterm, graf, pinstar, and draw-rs. Markdown previews use comrak and syntect.

    Patreon GitHub Downloads Crates.io Downloads