https://github.com/theiskaa/nt
A command line note taking application
https://github.com/theiskaa/nt
cli go note-taking
Last synced: 11 months ago
JSON representation
A command line note taking application
- Host: GitHub
- URL: https://github.com/theiskaa/nt
- Owner: theiskaa
- License: apache-2.0
- Archived: true
- Created: 2021-12-07T09:09:28.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-27T06:02:52.000Z (over 1 year ago)
- Last Synced: 2025-04-12T22:04:07.888Z (about 1 year ago)
- Topics: cli, go, note-taking
- Language: Go
- Homepage:
- Size: 354 KB
- Stars: 22
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# NT
---
# Installation
See the [last release](https://github.com/theiskaa/nt/releases/latest), where you can find binary files for your ecosystem
### Brew:
```
brew install --build-from-source nt
```
### Curl:
```
curl -sfL https://raw.githubusercontent.com/theiskaa/nt/main/install.sh | sh
```
# Usage
### Help:
Run `nt help` or `nt -h` to see default [help.txt](https://github.com/theiskaa/nt/wiki/help.txt).
Use `nt [command] --help` for more information about a command.
---
### Settings (config):
The configuration file of **nt** is auto-generated, it'd be generated by `Init` command automatically whenever you run **nt** on your command line.
**Refer to settings documentation for details - [Settings Wiki](https://github.com/theiskaa/nt/wiki/Settings)**
---
### Remote service integration:
Currently available remote service is only Firebase, looking forward to provide another ways of decentralizing remote connections.
**Refer to [remote] command documentation for more - [Remote Wiki](https://github.com/theiskaa/nt/wiki/Remote)**
---
### Commands:
- **[See all notes](https://github.com/theiskaa/nt/wiki/List)** - `nt list`
- **[View note](https://github.com/theiskaa/nt/wiki/View)** - `nt view` or `nt view [name]`
- **[Create node(file or folder)](https://github.com/theiskaa/nt/wiki/Create)** - `nt create` or `nt create [title]`
- **[Make a directory](https://github.com/theiskaa/nt/wiki/Mkdir)** - `nt mkdir` or `nt md [name]`
- **[Rename node(file or folder)](https://github.com/theiskaa/nt/wiki/Rename)** - `nt rename` or `nt rename [name]`
- **[Edit note](https://github.com/theiskaa/nt/wiki/Edit)** - `nt edit` or `nt edit [name]`
- **[Remove node(file or folder)](https://github.com/theiskaa/nt/wiki/Remove)** - `nt remove` or `nt rm [name]`
- **[Copy note](https://github.com/theiskaa/nt/wiki/Copy)** - `nt copy`
- **[Cut note](https://github.com/theiskaa/nt/wiki/Cut)** - `nt cut`
- **[Fetch nodes(files and folders)](https://github.com/theiskaa/nt/wiki/Fetch)** - `nt fetch` or `nt pull`
- **[Push nodes(files and folders)](https://github.com/theiskaa/nt/wiki/Push)** - `nt push`
- **[Migrate Services(files and folders)](https://github.com/theiskaa/nt/wiki/Migrate)** - `nt migrate`
- **[Manage Settings](https://github.com/theiskaa/nt/wiki/Settings)** - `nt settings`
- **[Manage Remote Services](https://github.com/theiskaa/nt/wiki/Remote)** - `nt remote`
# Contributing
For information regarding contributions, please refer to [CONTRIBUTING.md](https://github.com/theiskaa/nt/blob/develop/CONTRIBUTING.md) file.