Docs
Components & Tools
sphere-cli

sphere-cli

Sphere CLI (sphere-cli) is a small bootstrap tool for sphere projects. It creates projects from templates, lists available templates, renames module paths, and provides lightweight service skeleton helpers.

It is intentionally not the primary build, deploy, or runtime orchestration tool. After a project is created, the generated Makefile, Buf, Go, Wire, Swag, Docker, and project-local tools own the day-to-day workflow.

Installation

To install sphere-cli, ensure you have Go installed and run the following command:

go install github.com/go-sphere/sphere-cli@latest

Usage

The general syntax for sphere-cli is:

sphere-cli [command] [flags]

For detailed information on any command, you can use the --help flag:

sphere-cli [command] --help

Commands

Here is an overview of the available commands.

Scope

sphere-cli is responsible for:

  • creating projects from official or custom templates;
  • listing available templates;
  • renaming Go module paths;
  • generating small service skeletons when useful.

sphere-cli is not responsible for:

  • building binaries;
  • running test and lint workflows;
  • generating every project artifact;
  • managing Docker or Kubernetes deployment;
  • replacing make, buf, go, wire, swag, or Docker.

create

Initializes a new Sphere project with a default template.

Usage:

sphere-cli create --name <project-name> [--module <go-module-name>] [--layout <template-uri>]

Flags:

  • --name string: (Required) The name for the new Sphere project.
  • --module string: (Optional) The Go module path for the project.
  • --layout string: (Optional) Custom template layout URI.

Example:

sphere-cli create --name myproject --module github.com/myorg/myproject

This command creates a new project directory with the sphere-layout template, including:

  • Makefile for build automation
  • buf configuration for protobuf management
  • Standard directory structure
  • Example configurations

After creation, initialize and run the project through make:

cd myproject
make init
make run

service

Generates small service skeletons, including Protobuf definitions and Go service implementations. This is a convenience helper, not the main repeatable generation pipeline.

For normal project regeneration, use the Makefile:

make gen/db
make gen/proto
make gen/docs
make gen/wire

This command has two subcommands: proto and golang.

service proto

Generates a .proto file for a new service.

Usage:

sphere-cli service proto --name <service-name> [--package <package-name>]

Flags:

  • --name string: (Required) The name of the service.
  • --package string: The package name for the generated .proto file (default: dash.v1).

Example:

sphere-cli service proto --name UserService --package api.v1

service golang

Generates the Go implementation for a service from its definition.

Usage:

sphere-cli service golang --name <service-name> [--package <package-name>] [--mod <go-module-path>]

Flags:

  • --name string: (Required) The name of the service.
  • --package string: The package name for the generated Go code (default: dash.v1).
  • --mod string: The Go module path for the generated code (default: github.com/go-sphere/sphere-layout).

Example:

sphere-cli service golang --name UserService --package api.v1 --mod github.com/myorg/myproject

rename

Renames the Go module path across the entire repository. This is useful when you need to change the module path after creating a project.

Usage:

sphere-cli rename --old <old-module-path> --new <new-module-path>

Common Workflows

  • Quick project setup and generation: ../../getting-started/quickstart
  • Day-to-day development loop: ../../getting-started/workflow

Best Practices

  1. Use consistent naming: Follow Go naming conventions for services and packages
  2. Organize proto files: Keep related messages and services in appropriate packages
  3. Version your APIs: Use versioned packages (e.g., api.v1, api.v2) for backward compatibility
  4. Document your protos: Add comments to your proto files for better generated documentation
  5. Run generation regularly: Use make gen/all frequently to keep generated code up to date

Common Issues and Solutions

Module Path Mismatches

If you need to change the module path after project creation:

sphere-cli rename --old github.com/old/path --new github.com/new/path

Missing Dependencies

If you encounter import errors, ensure all dependencies are properly installed:

make install  # Install required tools
make init     # Initialize dependencies

Stale Generated Code

If generated code seems out of sync:

make clean    # Clean generated files
make gen/all  # Regenerate everything
Last updated on
protoc-gen-route