# tyro-note

**Repository Path**: tyro-ch/tyro-note

## Basic Information

- **Project Name**: tyro-note
- **Description**: tyro-note 是一款专为开发者和极客打造的跨平台（macOS/Windows）终端日记应用 (TUI)。它打破了传统命令行工具“简陋”的固有印象，将极致的终端效率与现代化的视觉动效完美结合，通过 AI 赋能，让记录与回顾变得极具仪式感。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-12-31
- **Last Updated**: 2025-12-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# tyro-note

一个高质感的终端日记应用（Textual + Rich），支持历史浏览/编辑、AI 总结、情绪/天气标签、近半年打卡热力图、模糊搜索与动效。

## 安装（推荐）

需要 Python `>=3.10`。

### 方式 A：pipx 一键安装（全局命令）

```bash
python3 -m pip install --user -U pipx
python3 -m pipx ensurepath
pipx install git+https://gitee.com/tyro-ch/tyro-note.git
tyro-note
```

### 方式 B：像 codex 一样一行脚本安装

macOS：

```bash
curl -fsSL https://gitee.com/tyro-ch/tyro-note/raw/main/scripts/install.sh | sh
exec $SHELL -l
tyro-note
```

Windows（PowerShell）：

```powershell
powershell -NoProfile -ExecutionPolicy Bypass -Command "irm https://gitee.com/tyro-ch/tyro-note/raw/main/scripts/install.ps1 | iex"
# 重开终端
tyro-note
```

## 本地开发运行

```bash
python -m venv .venv
source .venv/bin/activate  # Windows: .venv\Scripts\activate
pip install -r requirements.txt
python -m tyro_note
```

## 使用说明（核心交互）

- `Tab`：在左侧历史 / 右侧输入之间切换（边框与标题会高亮提示当前操作区域）
- `Esc`：无论在任何状态（历史/编辑/预览/搜索），一键回到“新日记输入”（右侧输入区清空并聚焦）
- 写新日记：
  - 右侧输入内容 → `Enter` → 弹出标题 → 保存
  - `Shift+Enter`：插入换行
- 历史编辑：
  - 左侧选中 → `Enter` 打开（右侧会以“打字机流式”展示内容）→ 直接编辑 → `Enter` 保存
- 删除：
  - 左侧选中 → `Backspace/Delete` → 确认删除
- 搜索：
  - 右侧输入 `/search 关键词` → `Enter` → 左侧出现搜索框，实时过滤历史
  - `Esc` 退出搜索并恢复全部

## 特色功能

- **心情/环境标签**：保存内容时自动识别关键词（例如“开心/累/焦虑/热/冷/暖/太阳/下雨/下雪/风/雾”等），在历史列表前缀显示图标（最多 3 个）。
- **Activity Heatmap**：顶部右侧展示近半年 GitHub 风格热力图，最后一格为今天，并带月份缩写标注。
- **AI Summary（Coze SSE）**：在右侧输入 `summary` + `Enter`，选择范围后流式展示，`Enter/Y` 保存到桌面，`N/Esc` 丢弃。

## 数据存储

- 日记以纯文本保存到运行目录的 `./db/`（不是加密）
- 文件名：`[Title].txt`
- 文件内容：第一行 `[ISO_TIMESTAMP]`，后续为正文

## 打字机音效

- 默认开启，可用环境变量关闭：`TYRO_TICK_SOUND=0`
- macOS 可调音量：`TYRO_TICK_VOLUME=0.20`（0~1，数值越小越轻）

## Coze 配置

Coze 相关配置目前写死在 `tyro_note/config.py`（`bot_id/token/endpoint`），如需切换到你自己的 bot/token，请在该文件修改后重新安装。