Skip to main content

Install Kindling

Get Kindling running on your system.

Requirements​

  • Node.js 20.0.0 or later
  • pnpm, npm, or yarn

Installation​

# Using pnpm
pnpm add -g @eddacraft/kindling

# Using npm
npm install -g @eddacraft/kindling

# Using yarn
yarn global add @eddacraft/kindling

Verify installation:

kindling --version

Project Install​

Add to a project:

pnpm add -D @eddacraft/kindling

Run via:

pnpm kindling --help

Initial Setup​

After installation, initialise Kindling:

kindling init

This creates:

  • ~/.kindling/ — data directory
  • ~/.kindling/config.json — configuration
  • Default capsule — for immediate use

Output:

Kindling initialised.

Data directory: ~/.kindling
Default capsule: default

Next steps:
  kindling capsule create my-project
  kindling observe "First observation"
  kindling search "observation"

Verify Installation​

Test that everything works:

# Create a test observation
kindling observe "Test observation"

# Search for it
kindling search "test"

Expected output:

[2024-01-15T10:30:00Z] Test observation
  Capsule: default
  Source: manual

Configuration​

View current config:

kindling config show

Default configuration:

{
  "dataDir": "~/.kindling",
  "defaultCapsule": "default",
  "storage": {
    "type": "sqlite"
  }
}

Change Data Directory​

kindling config set dataDir /path/to/data

Change Default Capsule​

kindling config set defaultCapsule my-project

Uninstall​

# Remove the package
pnpm remove -g @eddacraft/kindling

# Optionally remove data
rm -rf ~/.kindling

Next: Create a capsule →