SoftwareONE CLI

Command line utility for SoftwareOne Marketplace Platform

Documentation

📚 Complete Usage Guide

Getting started

Prerequisites

• Docker and Docker Compose plugin (docker compose CLI)
• make
• CodeRabbit CLI (optional. Used for running review check locally)

Make targets overview

Common development workflows are wrapped in the Makefile. Run make help to see the list of available commands.

How the Makefile works

The project uses a modular Makefile structure that organizes commands into logical groups:

• Main Makefile (Makefile): Entry point that automatically includes all .mk files from the make/ directory
• Modular includes (make/*.mk): Commands are organized by category:
  • common.mk - Core development commands (build, test, format, etc.)
  • repo.mk - Repository management and dependency commands
  • migrations.mk - Database migration commands (Only available in extension repositories)
  • external_tools.mk - Integration with external tools

You can extend the Makefile with your own custom commands creating a local.mk file inside make folder. This file is automatically ignored by git, so your personal commands won't affect other developers or appear in version control.

Setup

Follow these steps to set up the development environment:

1. Clone the repository

git clone <repository-url>

cd swo-marketplace-cli

2. Build the Docker images

Build the development environment:

make build

This will create the Docker images with all required dependencies and the virtualenv.

3. Verify the setup

Run the test suite to ensure everything is configured correctly:

make test

You're now ready to start developing! See Running the cli for next steps.

Running the cli

Before running, ensure your .env file is populated.

Start the cli:

make run

Developer utilities

Useful helper targets during development:

make bash      # open a bash shell in the app container
make check     # run ruff, flake8, and lockfile checks
make check-all # run checks and tests
make format    # auto-format code and imports
make review    # check the code in the cli by running CodeRabbit