Lodestone CLI

CLI for managing Lodestone, a local-first document retrieval system using Docker.

The CLI handles downloading the latest Docker Compose configuration, starting containers, updating images, viewing logs, and stopping services.

Requirements

Before using Lodestone CLI, make sure you have:

• Node.js 18+
• Docker installed
• Docker daemon running
• Docker Compose available (docker compose)

Install

Recommended:

npm install -g lodestone-r

If you get permission errors on Linux:

sudo npm install -g lodestone-r

Usage

Start Lodestone:

lodestone start

Stop containers:

lodestone stop

Update configuration and images:

lodestone update

Remove containers and local images (keeps volumes and configs):

lodestone delete

Completely destroy all containers, images, volumes, and installation directories (keeps config):

lodestone prune

View logs:

lodestone logs

What gets installed

Lodestone stores files in:

~/.lodestone
~/.config/lodestone

The latest Docker Compose file is automatically downloaded from:

https://github.com/bremsstrahlung-57/lodestone

Web UI

After starting:

http://localhost:8090

Troubleshooting

Docker not detected

Make sure Docker is installed and running:

docker --version
docker compose version

Permission errors during install

Use:

sudo npm install -g lodestone-r

or install Node using nvm to avoid global npm permission issues.

License

MIT