README.zh-CN.md

English | 中文

Cloud Notebook in terminal, based on Gist. 🦋

终端中运行的云笔记本，基于 Gist 构建。

tnote 是一个运行在 Terminal 的云笔记本应用程序，让你可以在不同设备快速访问、同步内容，记录自己的想法。

• 应用 🎯
  • 快捷键、鼠标操作
  • 云端存储持久化，支持 Github/Gitee
  • 国际化
• 文件
  • 增删查改
• 详情 📝
  • Markdown 高亮
  • 编辑、保存
• 安装
  • binary
  • go install
  • docker

准备&配置

应用基于 gist 构建，支持 Github/Gitee 平台。

• 申请 Github access token，添加到环境变量 TNOTE_GIST_TOKEN。
• 申请 Gitee access token，添加到环境变量 TNOTE_GIST_TOKEN_GITEE。

# ~/.bashrc, github
export TNOTE_GIST_TOKEN="<your_access_token>"

环境变量	默认值	描述
TNOTE_GIST_TOKEN / TNOTE_GIST_TOKEN_GITEE		申请到的 access token
TNOTE_LANG / LANG	en_US	使用的语言，可选值：en_US、zh_CN

安装&运行

1. binary

Download，下载后直接执行即可，加入 PATH 更佳。

文件	适用系统
tnote.darwin-amd64	Mac amd64、Mac arm64
tnote.linux-amd64	Linux amd64
tnote.linux-arm64	Linux arm64

example:

# install
wget -O tnote [url]
sudo chmod a+x tnote
sudo mv tnote /usr/local/bin/tnote
# run
tnote

2. go install

需要 [email protected]+ 环境

# install
go install github.com/shalldie/tnote@latest
# run
tnote

3. docker

docker run -it -e TNOTE_GIST_TOKEN=$TNOTE_GIST_TOKEN shalldie/tnote:latest

LICENSE

MIT