Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion CLI.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This document describes all available command-line options for Dispenser.
## Usage

```sh
dispenser [OPTIONS]
dispenser [OPTIONS] [COMMAND]
```

## Options
Expand Down Expand Up @@ -48,6 +48,8 @@ No referenced variables
-------------------------------------------------------------------------------
```



### `-p, --pid-file <PATH>`

Specify the path to the PID file. This file is used to track the running Dispenser process and is required for sending signals with the `--signal` flag.
Expand Down Expand Up @@ -94,6 +96,29 @@ Display the current version of Dispenser.
dispenser --version
```

## Subcommands

### `dev`

Starts Dispenser in local development mode.

**Key features:**
- **Implicit Simulation**: Automatically enables SSL simulation (self-signed certificates) for all proxy hosts.
- **Selective Loading**: Only loads and renders services specified with the `--service` flag.
- **Dependency Pruning**: Automatically removes dependencies on services that are not being loaded, allowing selected services to start immediately without waiting for missing dependencies.

**Options:**
- `-s, --service <NAME>`: The name or path of the service(s) to run. Can be specified multiple times (e.g., `-s api -s db` or `-s api db`).

**Example:**
```sh
# Only run the 'api' service
dispenser dev --service api

# Run specific services and bypass others
dispenser dev -s web -s db
```

## Common Usage Patterns

### Running in Foreground (for testing)
Expand Down
Loading