gn
get_notes.md

gn (Get Notes) is a zero-dependency CLI note utility that saves your markdown files directly to a private GitHub, GitLab, Codeberg, or Bitbucket repository. It acts as a lightweight sync layer using nothing but native Bash and curl - no local Git installation or setup required.

When you run gn note-name, it instantly pulls the latest file version from your Git host via HTTP API, opens it in your default $EDITOR, and automatically pushes your changes back immediately as soon as you save and exit.

It runs completely in the foreground with zero background daemons, no local databases, and no tracking. It is built to give you seamless cloud backups while keeping your notes as raw, standalone text files under your own control.

bash - 80×24
user@terminal:~$
GNU nano 7.2 - hello.md
^G Get Help
^O Write Out
^W Where Is
^X Exit
user@terminal:~$ gn hello
user@terminal:~$ gn hello
Fetching latest cloud updates...
Syncing changes to repository...
Sync complete!
user@terminal:~$
Usage: gn [options] [note_name]

Options:
  -h        Show this help message
  -l        List all notes in your notes directory
  -g QUERY  Search for text across all notes (grep)
  -t        Quickly open today's journal note (YYYY-MM-DD.md)
  -d NOTE   Delete a note locally and from cloud remote repository
  -r OLD NEW Rename a note locally and on cloud remote repository
Examples:
  gn                  Opens index.md
  gn log              Creates log.md
  gn work/todo        Opens work/todo.md
user@terminal:~$

Quick install:

curl -fsSL https://gn-notes.pages.dev/install.sh -o install.sh && chmod +x install.sh && ./install.sh

Prerequisites & Git Cloud Configuration:

gn requires a private repository and a personal access token generated from your chosen Git host.

1 Git Cloud Workspace Account

Create an account with GitHub, GitLab, Codeberg, or Bitbucket if you do not already have one.

A GitHub Configuration

Create a private repository named gn and generate a token with full repo permissions.

🔗 GitHub PAT Token Docs 🔑 Direct Token Generation Link
B GitLab Configuration

Create a private project named gn. Generate a Personal Access Token inside your user settings and ensure you check the api scope permission box.

🔗 GitLab PAT Token Docs 🔑 Direct Token Generation Link
C Codeberg Configuration

Create a private repository named gn. Go to Settings → Applications to generate a token with repository access permissions.

🔗 Codeberg Token Auth Docs 🔑 Direct Token Generation Link
D Bitbucket Configuration

Create a private repository named gn. Bitbucket uses App Passwords rather than personal access tokens - generate one under your account settings with Repositories: Read and Write permissions checked. Use your Bitbucket username as GIT_OWNER and the App Password as GIT_TOKEN.

🔗 Bitbucket App Passwords Docs 🔑 Direct App Password Creation Link

Download gn

Run the one-liner below, or manually configure gn using the directions further down.

Option A: One-liner (Recommended)

Paste this into your terminal. It downloads install.sh, makes it executable, and runs it. You will be prompted to select your platform and credentials.

Paste Into Terminal

curl -fsSL https://gn-notes.pages.dev/install.sh -o install.sh && chmod +x install.sh && ./install.sh

Prefer to inspect before running? Download install.sh first.

Option B: Manual Set Up

Download gn.sh Download gn.conf 
# Script content dynamic loading zone...

Manual Installation

If you prefer not to use the automated install.sh script, follow these steps to configure gn manually:

1 Create the Config File

Create the configuration folder hierarchy, then build the target configuration file: 

mkdir -p ~/gn
nano ~/gn/gn.conf
chmod 600 ~/gn/gn.conf

Add these four values, adjusting for your chosen Git platform: 

GIT_PROVIDER=git_cloud_provider
GIT_TOKEN=your_personal_access_token_here
GIT_OWNER=your_username
GIT_REPO=gn
  • GIT_PROVIDER - Your target hosting provider platform (github, gitlab, codeberg, or bitbucket).
  • GIT_TOKEN - Your personal access token with repository write permissions. For Bitbucket, use an App Password instead.
  • GIT_OWNER - Your user account name.
  • GIT_REPO - The name of the private repository (defaults to gn).
2 Make the Script Available Globally

Make the downloaded gn.sh script executable and copy it into your system's binaries directory: 

chmod +x gn.sh
sudo cp gn.sh /usr/local/bin/gn
3 Using gn

Run gn from your Terminal. Use flags for advanced features. 

gn                  # Opens your main index.md
gn daily-log        # Creates/Opens daily-log.md
gn work/reminders   # Creates work/ directory and opens reminders.md
gn -h               # Displays help page
gn -l               # Lists all your notes
gn -g "todo"        # Finds text matching "todo" inside any note
gn -t               # Opens today's automated scratchpad entry
gn -d daily-log     # Deletes daily-log.md locally and from cloud remote
gn -r old new       # Renames old.md to new.md locally and on cloud remote

Setting Up a Second Computer

Your notes live in the cloud and sync via the API, so there's nothing to clone. Just create the directory, drop in your config file, and install the script.

1 Create the notes directory and config file 
mkdir -p ~/gn
nano ~/gn/gn.conf
chmod 600 ~/gn/gn.conf

GIT_PROVIDER=github
GIT_TOKEN=your_personal_access_token_here
GIT_OWNER=your_username
GIT_REPO=gn
2 Install gn

Download gn.sh and configure permissions globally: 

chmod +x gn.sh
sudo cp gn.sh /usr/local/bin/gn

That's it - run gn and it will pull your notes before opening the editor.