English | 中文

Cloud Notebook in terminal, based on Gist. 🦋

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

tnote is a notebook application running on Terminal, allowing you to quickly access, synchronize content, and record your idea on different devices.

• Application 🎯
  • Shortcut keys, mouse operations
  • Cloud storage persistence, support Github/Gitee
  • i18n
• Files
  • Add, delete, check, and modify
• Detail 📝
  • Markdown highlighted
  • Edit and save
• Installation
  • binary
  • go install
  • docker

Prepare & Config

The application is built on gist, support Github/Gitee.

• Applying for Github access token, and then add it to the environment variable TNOTE_GIST_TOKEN。
• Applying for Gitee access token, and then add it to the environment variable TNOTE_GIST_TOKEN_GITEE。

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

Environment Variable	Default	Description
TNOTE_GIST_TOKEN / TNOTE_GIST_TOKEN_GITEE		access token applied for
TNOTE_LANG / LANG	en_US	Language preferred, optional values: en_US、zh_CN

Installation

1. binary

Download, download and execute it, adding to PATH would be even better.

File	OS
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

Need go@1.20+ environment.

# 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