2.0 KiB
2.0 KiB
layout, title, description, toc
| layout | title | description | toc |
|---|---|---|---|
| default | Sunbeam CLI Documentation | Comprehensive documentation for the Sunbeam local dev stack manager | true |
Sunbeam CLI Documentation
Welcome to the comprehensive documentation for Sunbeam CLI - a powerful local development stack manager for Kubernetes-based applications.
Overview
Sunbeam is a command-line tool designed to simplify the management of local development environments for Kubernetes applications. It provides a comprehensive suite of commands to handle cluster operations, service management, secret handling, and more.
Key Features
- Cluster Management: Bring up and tear down local Kubernetes clusters
- Service Operations: Manage services, logs, and health checks
- Secret Management: Secure credential handling with OpenBao integration
- Manifest Management: Kustomize-based manifest application with domain substitution
- User Management: Identity management for development environments
- Tool Bundling: Automatic download and management of required binaries
Getting Started
Installation
# Clone the repository
git clone https://src.sunbeam.pt/studio/cli.git
cd cli
# Install dependencies
pip install .
# Verify installation
sunbeam --help
Basic Usage
# Start your local cluster
sunbeam up
# Check cluster status
sunbeam status
# Apply manifests
sunbeam apply
# View service logs
sunbeam logs ory/kratos
Documentation Structure
- CLI Reference: Complete command reference
- Sol Code: Terminal coding agent powered by Sol
- Core Modules: Detailed module documentation
- Architecture: System architecture and design
- Usage Examples: Practical usage scenarios
- Development Guide: Contributing and extending Sunbeam
Support
For issues, questions, or contributions, please refer to the Git repository.