Skip to content

Getting Started with Composable

Composable is a collection of Docker Compose fragments and a CLI tool to manage them.

Installation

Install the CLI from npm:

npm install -g @voidrot/composable

You can also run without global install:

npx @voidrot/composable search

For local development, clone the repository and build from source:

git clone https://github.com/voidrot/composable.git
cd composable
npm install
npm run build
npm link

Adding your first fragment

To add a PostgreSQL fragment to your project:

composable add compose postgresql

This will:

  1. Fetch the postgresql.yml fragment.
  2. Store it in ./.compose/postgresql.yml.
  3. Update your local .env file with default environment variables.