https://github.com/shalldie/tnote

Cloud Notebook in terminal. 终端中运行的云笔记本。
https://github.com/shalldie/tnote

go note notebook ternimal tnote

Last synced: 5 months ago
JSON representation

Cloud Notebook in terminal. 终端中运行的云笔记本。

• Host: GitHub
• URL: https://github.com/shalldie/tnote
• Owner: shalldie
• License: mit
• Created: 2022-08-08T07:31:36.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-27T06:40:14.000Z (about 2 years ago)
• Last Synced: 2025-04-09T10:21:36.438Z (about 1 year ago)
• Topics: go, note, notebook, ternimal, tnote
• Language: Go
• Homepage:
• Size: 210 KB
• Stars: 9
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          



English | [中文](./README.zh-CN.md)







### Cloud Notebook in terminal, based on Gist. 🦋

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

[![Release Version](https://img.shields.io/github/v/release/shalldie/tnote?display_name=tag&logo=github&style=flat-square)](https://github.com/shalldie/tnote)

[![Docker Image Version](https://img.shields.io/docker/v/shalldie/tnote/latest?style=flat-square&logo=docker)](https://hub.docker.com/r/shalldie/tnote/tags)

[![Go Version](https://img.shields.io/github/go-mod/go-version/shalldie/tnote?label=go&logo=go&style=flat-square)](https://github.com/shalldie/tnote)

[![Go Reference](https://pkg.go.dev/badge/github.com/shalldie/tnote.svg)](https://pkg.go.dev/github.com/shalldie/tnote)

[![Build Status](https://img.shields.io/github/actions/workflow/status/shalldie/tnote/ci.yml?logo=github&style=flat-square)](https://github.com/shalldie/tnote/actions)

[![License](https://img.shields.io/github/license/shalldie/tnote?logo=github&style=flat-square)](https://github.com/shalldie/tnote)





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

- [x] Application 🎯

  - [x] Shortcut keys, mouse operations

  - [x] Cloud storage persistence, support Github/Gitee

  - [x] i18n

- [x] Files

  - [x] Add, delete, check, and modify

- [x] Detail 📝

  - [x] Markdown highlighted

  - [x] Edit and save

- [x] Installation

  - [x] binary

  - [x] go install

  - [x] docker

## Prepare & Config

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

- [Applying for Github access token](https://github.com/settings/tokens/new), and then add it to the environment variable `TNOTE_GIST_TOKEN`。

- [Applying for Gitee access token](https://gitee.com/profile/personal_access_tokens/new), and then add it to the environment variable `TNOTE_GIST_TOKEN_GITEE`。

```bash

# ~/.bashrc, github

export TNOTE_GIST_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](https://github.com/shalldie/tnote/releases), 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:

```bash

# 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.

```bash

# install

go install github.com/shalldie/tnote@latest

# run

tnote

```

### 3. docker

```bash

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

```

## LICENSE

MIT