Documentation / guide
Installation
Get up and running with the Kthulu CLI and development environment.
SSG Generated
Kthulu is a Go-based CLI tool. To get started, you'll need a few prerequisites.
Prerequisites
- Go 1.21+: Kthulu is built with Go. Download Go
- Node.js 18+: Required for frontend development and the Hub. Download Node.js
- Docker (Optional): Recommended for running local databases and services.
Installing the CLI
You can install the Kthulu CLI directly using go install.
go install github.com/pmaojo/kthulu-go/cmd/kthulu@latest
Ensure your $(go env GOPATH)/bin is in your system PATH.
export PATH=$PATH:$(go env GOPATH)/bin
Verifying Installation
Run the following command to verify that Kthulu is installed correctly:
kthulu version
You should see output similar to:
Kthulu CLI v1.0.0
Setup & Configuration
After installation, initialize your local configuration:
kthulu init
This will set up the ~/.kthulu directory for plugins and local cache.
Next Steps
Now that you have the CLI installed, take the Quick Start Tour to build your first application.