Installation

Install the PostKit CLI, one of the tools in the PostKit framework.

Requirements

Before installing PostKit CLI, ensure you have the following:

Requirement	Version	Download
Node.js	>= 18.0.0	nodejs.org
npm	(comes with Node.js)	npmjs.com
Docker	Latest	docker.com
Docker Compose	(comes with Docker Desktop)	Included with Docker Desktop
PostgreSQL CLI	psql, pg_dump	postgresql.org/download

Installing Prerequisites

Node.js & npm:

# Verify installation
node --version
npm --version

Docker:

• Download and install Docker Desktop
• Verify installation: docker --version

PostgreSQL CLI:

• macOS: brew install postgresql
• Ubuntu/Debian: sudo apt-get install postgresql-client
• Windows: Download from postgresql.org
• Verify installation: psql --version

Install PostKit CLI

From npm

npm install -g @appritech/postkit

From source

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

# Install dependencies
npm install

# Build
npm run build

# Link globally
npm link

Verify Installation

postkit --version
postkit --help

Development Mode

For development, you can run the CLI directly from source without building:

cd /path/to/postkit/cli
npm run dev -- <module> <command>

# Example
npm run dev -- db status