CLI Reference

Complete reference for the synfire command-line tool for automation and CI/CD.

Installation

Install Synfire to use the CLI:

pip install synfire

Verify the installation:

synfire --version

Authentication Commands

synfire login

Authenticate with the Synfire registry.

synfire login

Opens your browser for authentication. Tokens are stored securely in your OS credential store.

synfire logout

Remove stored credentials.

synfire logout

synfire whoami

Display the currently authenticated user.

synfire whoami

Model Commands

synfire pull

Download a model from the registry.

synfire pull <org>/<repo>[:<version>]

Examples:

# Pull latest version
synfire pull pabogdan/lifneuron

# Pull specific version
synfire pull pabogdan/lifneuron:1.0.0

# Pull to specific directory
synfire pull pabogdan/lifneuron -o ./models/

synfire push

Publish a model to the registry.

synfire push <org>/<repo> --version <version> --model <path> --card <path>

Example target shown below requires ownership of the repository.

synfire push pabogdan/lifneuron --version 1.0.0 \
  --model ./model.nir \
  --card ./nir-card.json

synfire search

Search for models in the registry.

synfire search <query> [--platforms <target>] [--tags <tag>]

Example:

synfire search lif --tags single-neuron

Environment Variables

SYNFIRE_TOKEN - API token for authentication (CI/CD)
SYNFIRE_API_URL - Override the API endpoint (advanced)