nebula‑notes Documentation

Your interstellar notebook for ideas that orbit the mind.

Getting Started

Installation

nebula‑notes runs anywhere the cosmos permits – your laptop, a VM, or a distant starship.

npm install -g nebula-notes
nebula-notes init my‑galaxy

After init, a nebula.json file appears, describing your notebook’s orbital parameters.

API Overview

Core Concepts

  • Stars – top‑level categories (e.g., research, personal)
  • Planets – sub‑categories within a star
  • Comets – fleeting notes that auto‑expire after 7 days

JavaScript Example

import { nebula } from 'nebula-notes';

nebula.star('research').planet('quantum').add({
  title: 'Entangled Thoughts',
  body: 'When two ideas collide…'
});
FAQ & Troubleshooting

Why does my nebula sometimes flicker?

That’s just the universe reminding you that ideas are not static. Refresh or take a coffee break.

Can I export my notes?

Yes! nebula-notes export --format markdown ships them to your local nebula.

Explore More