Skip to main content

CLI Command Catalog

A searchable reference for CLI scripts and commands across Symphony Core repositories. Find the right command by use case, repository, or keyword.

How to Use This Catalog

  • Know what you want to do? Browse By Use Case to find commands grouped by workflow (deployment, debugging, device management, etc.)
  • Know which repo? Browse By Repo to see all commands from a specific repository
  • Know the command name? Browse All Commands or use the search bar above

Conventions

Each command page includes:

  • Overview -- what the command does and when to use it
  • Usage -- copy-pasteable invocation with all options
  • Prerequisites -- repo, dependencies, environment variables
  • Examples -- 1-3 concrete scenarios

Covered Repositories

RepositoryDescriptionCommands
device-deploymentsDevice lifecycle management, fleet health, hardware auditing40+
github-automatorGitHub repo administration, inventory, compliance auditing16
pg-exportPostgreSQL data export to CSV4 modes
sc-infrastructureCore Docker infrastructure and service management6
ra-infrastructurePersonal infrastructure and homelab management48
sc-finance-syncFinancial data synchronization4
snipeit-asset-managementAsset tracking and label printing4+
homelab-deployAnsible/Docker IaC deployment to Linux hosts12

For the full list of org repositories, see the Repository Inventory.

Contributing

To add or update a command entry:

  1. Create a new .md file in docs/cli/commands/ using the command template below
  2. Add a reference link from the appropriate by-use-case/ and by-repo/ pages
  3. Submit a PR

Command Template

---
title: command name
description: One-line description
tags: [repo-name, category, relevant-tags]
category: use-case-category
repos: [repo-name]
path: relative/path/to/source.py
language: python
---

# `command name`

## Overview

What it does and when to use it.

## Usage

\```bash
command name [OPTIONS]
\```

## Options

| Option | Description | Default |
|--------|-------------|---------|
| `--flag` | What it does | value |

## Prerequisites

- **Repo**: repo-name
- **Dependencies**: what's needed
- **Environment**: required env vars

## Examples

### Basic usage

\```bash
command name
\```