README
¶
⚠️ Project is archived (May 2023).
I moved to a simpler note-taking setup in 2023 so that I can focus on apps that help me write consistent high quality notes, instead of becoming procrastination machines.
See "PKMS in a nutshell" on
/r/ObsidianMD.
Atlas
Atlas is an open-source, local-first, markdown-based, note-taking tool that is built for those that enjoy using a CLI and use VS Code as their daily code editor. It is a niche personal knowledge management (PKM) solution built primarily for developers who value simplicity, speed and consistent hierarchical note structure.
Install
git clone git@github.com:revett/atlas.git
cd atlas/
make install-cli-locally
echo "path: ~/notes" > ~/.atlas-notes.yml
Usage
All notes in Atlas must use a base type, from the following:
areaentitymeetingprojectscratchsystem
atlas {type}
atlas scratch
Flags
# Before creating the new note, run the doctor command.
atlas {type} --auto-doctor
# Disable validation.
atlas {type} --auto-doctor=false
# Append a code snippet Markdown section to the note.
atlas {type} --code-snippet
Doctor
atlas doctor
Shell Completion
atlas completion -h
Roadmap
🗂 See TODO.md.
Why?
Atlas is a niche tool in the PKM ecosystem that was originally developed by @revett as a Bash script after becoming frustrated with overly complex GUI-based tools. It will appeal to those that:
- Use VS Code as their daily code editor
- Prefer to use a CLI to create and manage notes in a knowledge base
- Value consistent hierarchical note structure, simplicity, and speed
The project has taken inspiration from Dendron, and can be seen as a lightweight alternative that is CLI focused.
Features
Atlas is designed to be used alongside VS Code and the Memo extension by @svsool. It's aim is to provide best-in-class features for creating, managing, and searching notes; and leaves editing notes to Svyat Sobol's (@svsool) excellent extension.
FAQ
📘 Nothing here yet.
Credits
- Inspiration from the Dendron README
- Roadmap ideas from Dendron, Foam, Obsidian and RelaNote
- All images generated by Midjourney
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
base
Package base provides functionality for operating on the entire local knowledge base.
|
Package base provides functionality for operating on the entire local knowledge base. |
|
cmd
Package cmd provides logic for github.com/spf13/cobra commands in the CLI.
|
Package cmd provides logic for github.com/spf13/cobra commands in the CLI. |
|
file
Package file provides general functionality for operating on files locally.
|
Package file provides general functionality for operating on files locally. |
|
input
Package input provides functionality that makes use of the github.com/charmbracelet/bubbletea package for terminal input.
|
Package input provides functionality that makes use of the github.com/charmbracelet/bubbletea package for terminal input. |
|
metadata
Package metadata provides functionality for generating, parsing and operating on Front Matter metadata within Markdown files.
|
Package metadata provides functionality for generating, parsing and operating on Front Matter metadata within Markdown files. |
|
note
Package note provides functionality for operating on a local Markdown note.
|
Package note provides functionality for operating on a local Markdown note. |
|
schema
Package schema provides functionality and reference values related to the base schema design of notes (e.g.
|
Package schema provides functionality and reference values related to the base schema design of notes (e.g. |
|
validate
Package validate provides validation logic for checking over a local knowledge base.
|
Package validate provides validation logic for checking over a local knowledge base. |