@cruxgarden/cli

v0.0.17

Published

a month ago

Crux Garden CLI

0High
0Medium
0Low

willstepp

crux cruxgarden api cli docker knowledge-management

What is Crux Garden?

Crux Garden is a model of how ideas manifest and develop over time. The heart of the model is the Crux, an atomic representation of an idea. In our implementation, a Crux can be text, media, code, or any digital content worth preserving. But Cruxes, just like ideas, don't exist in isolation. Ideas have origins. They lead to new ideas. They evolve. And often, they randomly connect. So it is with Cruxes. In Crux Garden, there are four types of relationships Cruxes can have with each other. These are called Dimensions:

GATES — Cruxes which influenced or inspired a Crux; its origins and sources.
GARDENS — Cruxes which emerged or grew from a Crux, its creations and consequences.
GROWTH — How a Crux developed over time, its transformation and refinement.
GRAFTS — Cruxes which connect to a Crux laterally, its associations and resonances.

These four Dimensions capture the fundamental ways that Cruxes, or ideas, relate to one another.

The power of a system that models ideas at such a primitive scale is that literally any idea or framework of ideas can be realized inside Crux Garden: interactive fiction with evolving storylines, personal knowledge bases connecting insights across domains, product development roadmaps linking requirements to releases, research systems tracking citations and discoveries, or anything else where ideas have origins, consequences, transformation, and connection.

Along with Cruxes and Dimensions, there are several other types including Tags, Themes, and Paths. See the database schema in db/schema.sql or the API documentation at /docs for details.

For further reading on the goals and ambitions of Crux Garden, explore the history of the Digital Garden movement and the 1945 essay As We May Think by Vannevar Bush.

Will Stepp, October 2025

CLI

The Crux Garden CLI tool helps manage the Crux Garden Nursery environment with Docker.

The Nursery is a production-like demo environment with sample data, perfect for trials, demos, and showcasing features.

Prerequisites

Docker installed and running
Node.js 18 or higher

Installation

Install from npm

Install globally with npm:

npm install -g @cruxgarden/cli

Or use with npx (no installation required):

npx @cruxgarden/cli nursery start

Local Development

To develop or test the CLI locally:

# Clone the repository
git clone https://github.com/CruxGarden/cli.git
cd cli

# Install dependencies
npm install

# Link the CLI globally for testing
npm link

# Now you can use the `crux` command
crux --help

# When done, unlink
npm unlink -g @cruxgarden/cli

Quick Start

Start the Nursery environment:

crux nursery start

The API will be available at http://localhost:3000 with demo data loaded.

View logs:

crux nursery logs

Stop the environment:

crux nursery stop

Commands

All commands are scoped under crux nursery:

`crux nursery start`

Start the Nursery environment (API, PostgreSQL, Redis with demo data).

crux nursery start

# With inline environment variables
crux nursery start API_PORT=3001

# With options and environment variables
crux nursery start --db-only JWT_SECRET=my-secret

Options:

--db-only - Start only database services (PostgreSQL and Redis)

Environment Variables:

You can pass environment variables directly on the command line in KEY=VALUE format after the command and options. These override values from your .env file.

`crux nursery stop`

Stop the Nursery environment. Data is preserved.

crux nursery stop

`crux nursery restart`

Restart the Nursery environment.

crux nursery restart

Options:

--db-only - Restart only database services (PostgreSQL and Redis)

`crux nursery status`

Show the status of all Nursery services.

crux nursery status

`crux nursery logs`

View logs from all Nursery services.

crux nursery logs

# Follow logs (like tail -f)
crux nursery logs -f

`crux nursery pull`

Pull the latest API image from GitHub Container Registry.

crux nursery pull

`crux nursery reset`

Complete fresh reset: stops everything, deletes all data and volumes, pulls the latest image, and starts fresh. Warning: This deletes all data!

crux nursery reset

`crux nursery clean`

Stop and remove all Nursery containers and volumes. Warning: This deletes all data!

crux nursery clean

`crux nursery purge`

Stop and remove ALL Nursery resources including containers, volumes, AND images. Warning: This deletes everything including downloaded images! You'll need to re-download images on next start.

crux nursery purge

This is more aggressive than clean - it removes Docker images too, which means:

Frees up more disk space
Requires re-downloading images (~100-500MB) on next start
Useful when you want to completely remove all traces of the Nursery

`crux nursery db start`

Start only Nursery database services (PostgreSQL and Redis).

crux nursery db start

`crux nursery db stop`

Stop Nursery database services.

crux nursery db stop

`crux nursery db connect`

Connect to the Nursery PostgreSQL database with psql.

crux nursery db connect

Useful psql commands:

\dt - List all tables
\d table_name - Describe a table
\q - Quit

`crux nursery redis connect`

Connect to Nursery Redis with redis-cli.

crux nursery redis connect

`crux nursery api connect`

Open a shell in the Nursery API container.

crux nursery api connect

What is the Nursery?

The Nursery is a production-like demo environment that:

Uses the published Docker image from ghcr.io/cruxgarden/api:latest
Includes demo data - Sample cruxes, paths, and relationships for showcasing
Runs standalone - Bundled PostgreSQL and Redis, no external dependencies
Perfect for demos - Show features to stakeholders, QA testing, trials

Services:

API: http://localhost:3000 - Crux Garden API (published image with demo data)
PostgreSQL: localhost:5432 - Database
Redis: localhost:6379 - Cache

Environment Variables

The Nursery environment has defaults for all environment variables, so configuration is optional. You can override variables in two ways:

1. Using a `.env` file

Create a .env file in your working directory:

# Port Mappings
API_PORT=3000          # External API port
POSTGRES_PORT=5432     # External PostgreSQL port
REDIS_PORT=6379        # External Redis port

# PostgreSQL Configuration
POSTGRES_DB=cruxgarden
POSTGRES_USER=cruxgarden
POSTGRES_PASSWORD=cruxgarden_nursery_password

# Database & Cache URLs (override to use external services)
DATABASE_URL=postgresql://cruxgarden:cruxgarden_nursery_password@postgres:5432/cruxgarden
REDIS_URL=redis://redis:6379

# Security (has dev default, but you should use a different one)
JWT_SECRET=your-super-secret-jwt-key-min-32-chars

# AWS Configuration (defaults to "dummy" values)
AWS_ACCESS_KEY_ID=your-key
AWS_SECRET_ACCESS_KEY=your-secret
AWS_REGION=us-east-1
[email protected]
AWS_S3_ATTACHMENTS_BUCKET=crux-garden-attachments

# Optional Configuration
NODE_ENV=production
CORS_ORIGIN=*
LOG_LEVEL=info
HOSTNAME=0.0.0.0
DB_POOL_MIN=2
DB_POOL_MAX=10
DB_POOL_IDLE_TIMEOUT=30000
DB_POOL_ACQUIRE_TIMEOUT=60000
RATE_LIMIT_TTL=60000
RATE_LIMIT_MAX=100

2. Using inline environment variables

Pass environment variables directly on the command line:

# Override ports
crux nursery start API_PORT=3001

# Override database connection
crux nursery start DATABASE_URL=postgresql://user:pass@external-host:5432/db

# Multiple variables
crux nursery start API_PORT=3001 JWT_SECRET=my-secret AWS_REGION=us-west-2

# Works with all start commands
crux nursery api start API_PORT=4000
crux nursery db start POSTGRES_PORT=5433
crux nursery restart API_PORT=3001
crux nursery reset JWT_SECRET=new-secret

Note: Inline environment variables override values from your .env file. You can override DATABASE_URL and REDIS_URL to connect the API to external database/cache services instead of the bundled ones.

Common Workflows

Demo/Trial Setup

Use the Nursery environment for demos, trials, or showcasing features:

# First time setup - pulls images and starts with demo data
crux nursery start

# Access the API at http://localhost:3000

# Stop (keeps data for next demo)
crux nursery stop

# Restart for another demo
crux nursery start

# Get latest updates and fresh data
crux nursery reset

Testing Latest Changes

Pull the latest published image and test:

# Pull latest image
crux nursery pull

# Restart with latest image
crux nursery restart

# Or do a complete fresh reset
crux nursery reset

Database Exploration

Connect to the database to explore the demo data:

# Start the environment
crux nursery start

# Connect to PostgreSQL
crux nursery db connect

# In psql:
# \dt - list tables
# SELECT * FROM cruxes; - view demo cruxes
# \q - quit

Troubleshooting

Port already in use

If you get an error about ports being in use, stop any existing services:

# Check what's using the ports
lsof -i :3000  # Nursery API
lsof -i :5432  # Nursery PostgreSQL
lsof -i :6379  # Nursery Redis

# Stop the Nursery
crux nursery stop

# Or clean everything
crux nursery clean

Containers won't start

Try cleaning and restarting:

crux nursery clean
crux nursery start

Database connection issues

Make sure the database is healthy:

crux nursery status

You should see Up (healthy) for postgres.

Nursery image is outdated

Pull the latest image and restart:

crux nursery pull
crux nursery restart

# Or do a complete fresh reset
crux nursery reset

Docker daemon not running

Make sure Docker Desktop (or Docker daemon) is running:

docker ps

If you get an error, start Docker Desktop.

Development Scripts

The CLI also exposes npm scripts that you can use during development:

# Run tests
npm test

# Format code with Prettier
npm run format

# Run nursery commands directly (for testing)
npm run docker:nursery
npm run docker:nursery:logs
npm run docker:nursery:down
npm run docker:nursery:clean
npm run docker:nursery:reset
npm run docker:nursery:pull
npm run docker:nursery:db
npm run docker:nursery:db:stop
npm run docker:nursery:db:connect
npm run docker:nursery:redis:connect
npm run docker:nursery:api:connect

Future Features

This CLI will eventually support:

Cloud mode - Login and interact with the official Crux Garden API at api.crux.garden
Data operations - Export, import, and sync data between environments
Multi-instance management - Switch between local and cloud instances

API Development

If you're developing the Crux Garden API itself, use the npm scripts in the API repository instead of this CLI. This CLI is specifically for running the published Nursery environment.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT License

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme