### Getting User Input Example

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/README.md

Provides an example of how to ask a question to the user and handle cases where the CLI is running in non-interactive mode.

```go
answer, err := interactive.Ask("Question")
if errors.Is(err, interactive.ErrNonInteractive) {
    answer = "default"
}
```

--------------------------------

### Making API Calls Example

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/README.md

Demonstrates how to make an API call to get environment details, including error handling and data formatting.

```go
options := environment.NewItemOptions("env-123")
env, err := environment.Get(options)
if err != nil {
    return lib.FormatCommandError(cmd, err)
}
return lib.FormatCommandData(cmd, env)
```

--------------------------------

### Example: Get Environment Definition

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/environment-api.md

Demonstrates how to retrieve an environment's definition using GetDefinition. Ensure you have the environment ID.

```go
options := environment.NewItemOptions("env-123")
def, err := environment.GetDefinition(options)
if err != nil {
    return err
}
// def contains environment definition
```

--------------------------------

### Example: Get Environment Kubeconfig

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/environment-api.md

Demonstrates how to retrieve and save an environment's kubeconfig using GetKubeconfig. Requires environment ID and file system access.

```go
options := environment.NewItemOptions("env-123")
kubeconfig, err := environment.GetKubeconfig(options)
if err != nil {
    return err
}
// Write to file or use for kubectl
os.WriteFile("kubeconfig.yaml", []byte(kubeconfig), 0600)
```

--------------------------------

### Accessing Configuration Example

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/README.md

Demonstrates how to retrieve global settings, such as output format and profile, from the configuration.

```go
settings := config.GetSettings()
format := settings.OutputFormat
profile := settings.Profile
```

--------------------------------

### Create Component Variable Example

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/component-api.md

Example demonstrating how to create a new component variable with specific details.

```go
// Create component variable
createOpts := &component_variable.CreateOptions{
    ComponentID: "comp-123",
    Name:        "API_KEY",
    Value:       "secret123",
}
variable, err := component_variable.Create(createOpts)
```

--------------------------------

### Go Import Path Example

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/README.md

Demonstrates the correct import path for the configuration package in Go.

```go
// Real import paths
import "bunnyshell.com/cli/pkg/config"
```

--------------------------------

### Start Environment

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/environment-api.md

Starts a stopped environment. Requires options with the environment ID.

```go
func Start(options *common.ItemOptions) (*sdk.EnvironmentItem, error)
```

--------------------------------

### Example YAML Configuration

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/configuration-manager.md

An example of a configuration file in YAML format, showing default profile, output format, timeout, and profile-specific settings.

```yaml
defaultProfile: myprofile
outputFormat: json
timeout: 30s
profiles:
  myprofile:
    host: environments.bunnyshell.com
    scheme: https
    token: your-token-here
    context:
      organization: org-123
      project: proj-456
      environment: env-789
```

--------------------------------

### Start Development Container

Source: https://github.com/bunnyshell/cli/blob/master/CLAUDE.md

Initializes the Docker-based development environment.

```bash
cd .dev
docker-compose up -d
```

--------------------------------

### List Resources Example

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/api-client.md

Shows how to list resources and iterate through the embedded items. Handles pagination by default.

```go
options := common.NewListOptions()
options.SetPage(1)
items, err := environment.List(options)
if err != nil {
    return err
}
for _, item := range items.Embedded {
    fmt.Println(item.Name)
}
```

--------------------------------

### Install Bunnyshell CLI via Generic Installer

Source: https://github.com/bunnyshell/cli/blob/master/README.md

Downloads and executes the installation script with a checksum verification step.

```sh
installer=$(curl --silent https://raw.githubusercontent.com/bunnyshell/cli/master/installer.sh) \
    && [ "33cdd268adb1e26511b0cc90c9f4bf017bb145041677ca52d23a0f93cd13bd58 *stdin" = "$(echo -n "${installer}" | openssl dgst -sha256 -r)" ] \
    && (
        sh -c "${installer}" || :
    ) \
    || echo "Checksum did not match $(echo -n "${installer}" | openssl dgst -sha256 -r)"
;
```

```sh
installer=$(curl --silent https://raw.githubusercontent.com/bunnyshell/cli/master/installer.sh) \
    && [ "33cdd268adb1e26511b0cc90c9f4bf017bb145041677ca52d23a0f93cd13bd58 *stdin" = "$(echo -n "${installer}" | openssl dgst -sha256 -r)" ] \
    && (
        SUDO_INSTALL=true INSTALL_PATH=/usr/local/bin sh -c "${installer}" || :
    ) \
    || echo "Checksum did not match $(echo -n "${installer}" | openssl dgst -sha256 -r)"
;
```

--------------------------------

### Define DeployOptions Struct

Source: https://github.com/bunnyshell/cli/blob/master/CLAUDE.md

Example of the Option pattern used for deployment configurations.

```go
type DeployOptions struct {
  ID string
  WithoutPipeline bool
  Interval time.Duration
  // ...
}
```

--------------------------------

### Create Resource Example

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/api-client.md

Illustrates creating a new resource with specific options. Ensure all required fields in CreateOptions are provided.

```go
options := &environment.CreateOptions{
    Name: "production",
    ProjectID: "proj-123",
}
env, err := environment.Create(options)
if err != nil {
    return err
}
```

--------------------------------

### Start Environment

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/environment-api.md

Starts a stopped environment. Requires options containing the environment ID.

```APIDOC
## Start Environment

### Description
Starts a stopped environment.

### Method
(Not specified, likely a SDK method call)

### Parameters
#### Path Parameters
(None specified)

#### Query Parameters
(None specified)

#### Request Body
(None specified)

### Parameters
#### options (*common.ItemOptions) - Required - Options with environment ID

### Response
#### Success Response
- `*sdk.EnvironmentItem` - Updated environment
- `error` - Error if the operation fails

### Example
```go
options := environment.NewItemOptions("env-123")
updatedEnv, err := environment.Start(options)
if err != nil {
    // Handle error
}
// updatedEnv contains the started environment details
```
```

--------------------------------

### Get Raw HTTP Response Example

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/api-client.md

Shows how to use the `GetRaw` function to obtain the raw HTTP response along with the data. This is useful for inspecting headers or status codes.

```go
func GetRaw(options *common.ItemOptions) (*sdk.EnvironmentItem, *http.Response, error)
```

--------------------------------

### Output Abstraction Example

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/README.md

Shows how to use the output formatter with different output formats like stylish, json, yaml, or raw.

```go
formatter.Formatter(data, config.GetSettings().OutputFormat)
```

--------------------------------

### Generic Installer Script Usage

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/build-and-deployment.md

Downloads and executes the Bunnyshell CLI installer script from a remote URL. This is a convenient way to install the CLI on various systems.

```bash
curl -s https://raw.githubusercontent.com/bunnyshell/cli/master/installer.sh | \
  sh
```

--------------------------------

### Environment API Functions

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/api-client.md

Lists the main functions available in the Environment API package for managing environments. These include getting, listing, deploying, cloning, creating, deleting, starting, stopping, and aborting environments.

```go
func Get(options *common.ItemOptions) (*sdk.EnvironmentItem, error)
func List(options *common.ListOptions) (*sdk.EnvironmentListItem, error)

// Actions
func Deploy(options *DeployOptions) (*sdk.DeploymentItem, error)
func Clone(options *CloneOptions) (*sdk.EnvironmentItem, error)
func Create(options *CreateOptions) (*sdk.EnvironmentItem, error)
func Delete(options *common.ItemOptions) (*sdk.EnvironmentItem, error)
func Start(options *common.ItemOptions) (*sdk.EnvironmentItem, error)
func Stop(options *common.ItemOptions) (*sdk.EnvironmentItem, error)
func Abort(options *AbortOptions) (*sdk.EnvironmentItem, error)

// Information retrieval
func GetDefinition(options *common.ItemOptions) (*sdk.EnvironmentDefinitionResponse, error)
func GetKubeconfig(options *common.ItemOptions) (string, error)
```

--------------------------------

### Install Bunnyshell CLI via Homebrew

Source: https://github.com/bunnyshell/cli/blob/master/README.md

Installs the CLI using the Homebrew package manager.

```sh
brew install bunnyshell/tap/bunnyshell-cli
```

--------------------------------

### Go Module File Example

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/build-and-deployment.md

Shows a typical go.mod file structure, including the module path, Go version, toolchain, and required dependencies with their versions.

```go
module bunnyshell.com/cli

go 1.23

toolchain go1.23.2

require (
    bunnyshell.com/sdk v0.22.2
    bunnyshell.com/dev v0.7.2
    github.com/spf13/cobra v1.8.1
    // ... more dependencies
)
```

--------------------------------

### Example Configuration File

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/configuration.md

A sample YAML configuration file demonstrating default profile, output format, timeout, and profile-specific settings including host, scheme, token, and context details for organization, project, environment, and service component.

```yaml
defaultProfile: production
outputFormat: json
timeout: 30s

profiles:
  production:
    host: environments.bunnyshell.com
    scheme: https
    token: your-api-token-here
    context:
      organization: org-12345
      project: proj-67890
      environment: env-abc123
      serviceComponent: comp-xyz789

  staging:
    host: staging.environments.bunnyshell.com
    scheme: https
    token: staging-api-token
    context:
      organization: org-12345
      project: proj-staging
```

--------------------------------

### Execute Command in Component

Source: https://github.com/bunnyshell/cli/blob/master/CLAUDE.md

Example of the command execution flow for the bns exec utility.

```bash
$ bns exec comp-123 -- ls -la
  ↓
cmd/exec/root.go
  ↓
Parses component ID from positional arg
  ↓
Fetches component details via pkg/api/component
  ↓
Retrieves kubeconfig via pkg/api/environment
  ↓
Interactive pod selection via pkg/wizard/k8s
  ↓
Interactive container selection via pkg/wizard/k8s
  ↓
Creates exec command via pkg/k8s/kubectl/exec
  ↓
Executes command in container using k8s.io/kubectl/pkg/cmd/exec
```

--------------------------------

### Environment Lifecycle Commands

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/command-structure.md

Commands to manage the lifecycle of an environment: start, stop, and abort.

```bash
bns environments start <environment-id>
bns environments stop <environment-id>
bns environments abort <environment-id>
```

--------------------------------

### Go Function Signature Example

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/README.md

Illustrates actual function signatures for environment operations, including creating options and retrieving an environment.

```go
// Actual function signatures
options := environment.NewItemOptions("env-123")
env, err := environment.Get(options)
```

--------------------------------

### Handle Pagination Example

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/api-client.md

Demonstrates a loop to fetch all items across multiple pages. It continues fetching until the current page number is greater than or equal to the total number of pages.

```go
var allItems []*sdk.EnvironmentItem
for page := int32(1); ; page++ {
    options := common.NewListOptions()
    options.SetPage(page)
    items, err := environment.List(options)
    if err != nil {
        return err
    }
    allItems = append(allItems, items.Embedded...)
    if items.Page >= items.Total {
        break
    }
}
```

--------------------------------

### Listing with Pagination Example

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/README.md

Shows a pattern for displaying collections of items with pagination support, using a provided function to fetch the data.

```go
err := lib.ShowCollection(cmd, options, func() (lib.ModelWithPagination, error) {
    return environment.List(options)
})
```

--------------------------------

### Configuration Priority Example

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/configuration.md

Demonstrates the priority order for configuration settings, showing how CLI flags override environment variables, which override config file settings.

```bash
# Uses JSON from CLI (overrides everything)
bns environments list --output json

# Uses YAML from environment (overrides config file)
export bunnyshell_outputFormat=yaml
bns environments list

# Uses value from config file
bns environments list

# Uses default "stylish"
rm ~/.bunnyshell/config.yaml
bns environments list
```

--------------------------------

### Query Single Resource Example

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/api-client.md

Demonstrates how to query a single resource using its ID. Ensure you have the correct options and handle potential errors.

```go
options := environment.NewItemOptions("env-123")
env, err := environment.Get(options)
if err != nil {
    // Handle error
    return err
}
// Use env
```

--------------------------------

### Define CLI Flags

Source: https://github.com/bunnyshell/cli/blob/master/AGENTS.md

Examples for handling repeatable, required, and context-aware flags in cobra commands.

```go
var statuses []string
flags.StringArrayVar(&statuses, "status", statuses, "Filter by status (repeatable)")
```

```go
flags.AddFlag(option.GetRequiredFlag("id"))
```

```go
flags.AddFlag(options.Organization.GetFlag("organization"))
```

--------------------------------

### Configure Input Prompt with Validation and Defaults

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/interactive.md

Build a custom input prompt using the Input struct and its methods. This example demonstrates setting a default value, help text, and a custom validation function before asking for a string response.

```go
type Input struct {
    Message   string
    Default   string
    Help      string
    // validator and other fields...
}

// Methods:
// - SetValidate(validator survey.Validator) - Set validation function
// - AskString() (string, error) - Prompt and get string response
// - With<Option>() - Fluent methods for building complex prompts

// Example:
input := interactive.NewInput("Select database host")
input.Default = "localhost"
input.Help = "Hostname or IP address"
input.SetValidate(func(ans interface{}) error {
    host := ans.(string)
    if host == "" {
        return errors.New("host required")
    }
    return nil
})
answer, err := input.AskString()
```

--------------------------------

### Project Context in Config File

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/configuration.md

Example of setting the project context within a specific profile in the config.yaml file.

```yaml
profiles:
  myprofile:
    context:
      project: proj-67890
```

--------------------------------

### Add Profile Directly in Config File

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/configuration.md

Example of manually adding a profile configuration directly into the config.yaml file.

```yaml
profiles:
  myprofile:
    host: environments.bunnyshell.com
    scheme: https
    token: abc123...
```

--------------------------------

### Create a Spinner

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/utilities.md

Initializes a spinner with custom suffix text for visual progress indication. Use Start() and Stop() to control its display during operations.

```go
func MakeSpinner(suffix string) *spinner.Spinner
```

```go
s := util.MakeSpinner(" Deploying...")
s.Start()
// ... do work ...
s.Stop()
```

--------------------------------

### API Client Creation

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/architecture.md

Shows how to obtain API clients, either for the current profile or a specific one, and how to get a context that includes authentication and timeout settings.

```go
// Get API client for current profile
api := lib.GetAPI()

// Or for specific profile
api := lib.GetAPIFromProfile(profile)

// Context includes auth + timeout
ctx, cancel := lib.GetContext()
def cancel() 
```

--------------------------------

### Environment Context in Config File

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/configuration.md

Example of setting the environment context within a specific profile in the config.yaml file.

```yaml
profiles:
  myprofile:
    context:
      environment: env-abc123
```

--------------------------------

### Component Context in Config File

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/configuration.md

Example of setting the component/service context within a specific profile in the config.yaml file.

```yaml
profiles:
  myprofile:
    context:
      serviceComponent: comp-xyz789
```

--------------------------------

### Cobra Command Structure

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/architecture.md

Each command is implemented as a cobra.Command, defining its usage, descriptions, execution handler, and pre-run setup hooks.

```go
package main

import (
	"fmt"
	"os"

	"github.com/spf13/cobra"
)

var rootCmd = &cobra.Command{
	Use:   "bns",
	Short: "Bunnyshell CLI tool",
	Long:  `A command-line interface for managing Bunnyshell environments and resources.`,
	RunE: func(cmd *cobra.Command, args []string) error {
		// Default behavior or help message
		return cmd.Help()
	},
	PersistentPreRun: func(cmd *cobra.Command, args []string) {
		// Global setup logic, e.g., configuration loading
		fmt.Println("Running PersistentPreRun...")
	},
}

func Execute() {
	if err := rootCmd.Execute(); err != nil {
		fmt.Fprintf(os.Stderr, "Error: %v\n", err)
		os.Exit(1)
	}
}

func main() {
	Execute()
}

```

--------------------------------

### CLI Commands for Output Format Selection

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/formatter.md

Demonstrates how to specify the desired output format for CLI commands using the `--output` flag. Examples include JSON, YAML, and raw formats.

```bash
bns environments list --output json
bns components show --output yaml
bns events list --output raw
```

--------------------------------

### Profile Configuration in YAML

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/configuration.md

Example of how profiles are defined in the Bunnyshell config.yaml file, including default profile and specific profile settings.

```yaml
defaultProfile: production
profiles:
  production:
    token: ...
  staging:
    token: ...
```

--------------------------------

### List Git Information for Components

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/component-api.md

Lists Git information for multiple components. Use this to get an overview of the Git status across several components.

```Go
func GetGitList(options *common.ListOptions) (*GitList, error)
```

--------------------------------

### Singleton Configuration Manager Usage

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/architecture.md

Demonstrates how to load, access, and modify application settings using the singleton configuration manager. Load configuration at startup and access settings globally.

```go
config.MainManager.Load()              // Load at startup
settings := config.GetSettings()       // Access anywhere
config.MainManager.SetProfile(...)     // Modify config
```

--------------------------------

### Start Development Container

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/build-and-deployment.md

Starts the Docker development container in detached mode and opens an interactive bash session inside it.

```bash
cd .dev
docker-compose up -d
docker exec -it bunnyshell-cli /bin/bash
```

--------------------------------

### Custom Validator Function Example

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/interactive.md

Define custom validator functions conforming to the survey.Validator interface to enforce specific input rules. This example shows how to validate an API token.

```go
// Custom validator function
func validateToken(ans interface{}) error {
    token, ok := ans.(string)
    if !ok {
        return errors.New("invalid type")
    }
    if token == ""
 {
        return errors.New("token is required")
    }
    if len(token) < 20 {
        return errors.New("token too short")
    }
    return nil
}

// Usage
token, err := interactive.AskWithHelp(
    "Enter API token",
    "Token from https://environments.bunnyshell.com/access-token",
    validateToken,
)
```

--------------------------------

### Start Bunnyshell CLI Docker Container

Source: https://github.com/bunnyshell/cli/blob/master/AGENTS.md

Initiates the Bunnyshell CLI development Docker container if it's not running. Ensure you are in the .dev directory.

```bash
cd .dev && docker-compose up -d
```

--------------------------------

### Organization API

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/api-client.md

Provides functions to get and list organization details.

```APIDOC
## Organization API

### Description
Provides functions to get and list organization details.

### Functions
- `Get(options *common.ItemOptions) (*sdk.OrganizationItem, error)`: Retrieves a single organization.
- `List(options *common.ListOptions) (*sdk.OrganizationListItem, error)`: Lists all organizations.
```

--------------------------------

### Configuration Loading with Error Handling

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/errors.md

Demonstrates loading configuration and specifically handling the `ErrUnknownProfile` error.

```go
// Config loading with error handling
config.MainManager.Load()
if config.MainManager.Error != nil {
    if errors.Is(config.MainManager.Error, config.ErrUnknownProfile) {
        // Handle unknown profile
    }
    return config.MainManager.Error
}
```

--------------------------------

### Event API

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/api-client.md

Provides functions to list and get event details.

```APIDOC
## Event API

### Description
Provides functions to list and get event details.

### Functions
- `List(options *common.ListOptions) (*sdk.EventListItem, error)`: Lists all events.
- `Get(options *common.ItemOptions) (*sdk.EventItem, error)`: Retrieves a single event.
```

--------------------------------

### Get Environment Genesis Source

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/environment-api.md

Retrieves the Genesis source information for an environment.

```go
func GetGenesisSource(options *common.ItemOptions) (interface{}, error)
```

--------------------------------

### Get Environment

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/environment-api.md

Retrieves a single environment by its ID using the provided options.

```APIDOC
## Get Environment

### Description
Retrieves a single environment by ID.

### Method
GET (assumed based on function name and typical SDK patterns)

### Endpoint
`/environments/{environment_id}` (inferred)

### Parameters
#### Path Parameters
- **environment_id** (string) - Required - The ID of the environment to retrieve.

#### Query Parameters
None explicitly documented.

#### Request Body
None explicitly documented.

### Request Example
```go
options := environment.NewItemOptions("env-123")
env, err := environment.Get(options)
if err != nil {
    return lib.FormatCommandError(cmd, err)
}
return lib.FormatCommandData(cmd, env)
```

### Response
#### Success Response (200)
- **sdk.EnvironmentItem** - The retrieved environment data.

#### Response Example
(Response structure not explicitly provided in source, but would typically be a JSON object representing the environment)
```

--------------------------------

### CLI Build Process Structure

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/architecture.md

Illustrates the import structure of the main Go file, showing how commands are registered and how packages like API, config, and formatter are utilized.

```go
main.go
  └─ import cmd
      └─ cmd/root.go registers all commands
         └─ imports from pkg/api, pkg/config, pkg/formatter
```

--------------------------------

### Get Component Resources

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/component-api.md

Retrieves resource allocation for a component, including CPU, memory, and storage. Use this to understand the resource footprint of a component.

```Go
type ComponentResources struct {
    CPU      string  // CPU request/limit
    Memory   string  // Memory request/limit
    Storage  string  // Storage allocation
    // ... other fields
}
```

--------------------------------

### Get API Client from Specific Profile

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/utilities.md

Creates an API client using the configuration from a specific profile. Useful when working with multiple profiles or non-default configurations.

```Go
func GetAPIFromProfile(profile config.Profile) *sdk.APIClient
```

--------------------------------

### Registry Integration API

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/api-client.md

Provides functions to list and get registry integration details.

```APIDOC
## Registry Integration API

### Description
Provides functions to list and get registry integration details.

### Functions
- `List(options *common.ListOptions) (*RegistryIntegrationListItem, error)`: Lists all registry integrations.
- `Get(options *common.ItemOptions) (*RegistryIntegrationItem, error)`: Retrieves a single registry integration.
```

--------------------------------

### List Components in Environment

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/component-api.md

This snippet shows how to list all components within the current environment context. It's useful for obtaining a list of available components to select from.

```go
// List components in current environment context
options := common.NewListOptions()
components, err := component.List(options)

// Use first component ID
if len(components.Embedded) > 0 {
    comp := components.Embedded[0]
}
```

--------------------------------

### Kubernetes Integration API

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/api-client.md

Provides functions to list and get Kubernetes integration details.

```APIDOC
## Kubernetes Integration API

### Description
Provides functions to list and get Kubernetes integration details.

### Functions
- `List(options *common.ListOptions) (*K8sIntegrationListItem, error)`: Lists all Kubernetes integrations.
- `Get(options *common.ItemOptions) (*K8sIntegrationItem, error)`: Retrieves a single Kubernetes integration.
```

--------------------------------

### Get Git Information for Bunnyshell Component

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/command-structure.md

Retrieves Git information for a specified component.

```bash
bns git info [<component-id>]
```

--------------------------------

### Deploy an Environment

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/environment-api.md

Deploys an environment and creates a deployment pipeline. Options include environment ID, whether to skip pipeline creation, polling interval, and watch flag.

```go
deployOpts := &environment.DeployOptions{
    ID:    "env-123",
    Watch: true,
}
deployment, err := environment.Deploy(deployOpts)
if err != nil {
    return err
}
```

--------------------------------

### Get Environment Definition Secrets

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/command-structure.md

Retrieves secrets associated with an environment's definition.

```bash
bns secrets definition <environment-id>
```

--------------------------------

### Manage Bunnyshell Component Debugging

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/command-structure.md

Utilities for starting, stopping, and SSHing into component debugging sessions.

```bash
bns debug up <component-id>
```

```bash
bns debug down <component-id>
```

```bash
bns debug ssh <component-id>
```

--------------------------------

### Create a New Environment

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/environment-api.md

Creates a new environment with specified parameters including name and project ID. Optionally, a definition file can be provided.

```go
createOpts := &environment.CreateOptions{
    Name:      "production",
    ProjectID: "proj-123",
}
env, err := environment.Create(createOpts)
if err != nil {
    return err
}
```

--------------------------------

### Build and Test CLI

Source: https://github.com/bunnyshell/cli/blob/master/AGENTS.md

Commands for building the project and testing the resulting binary.

```bash
docker exec -it bunnyshell-cli make build-local
```

```bash
./dist/bns_darwin_arm64/bns [your-command] --help
```

```bash
./dist/bns_linux_amd64_v1/bns [your-command] --help
```

--------------------------------

### Environment Deployment Workflow

Source: https://github.com/bunnyshell/cli/blob/master/CLAUDE.md

Step-by-step execution flow for deploying an environment via the CLI.

```text
$ bns environments deploy my-env
  ↓
cmd/environment/action/deploy.go
  ↓
Validates K8s integration via pkg/api/environment
  ↓
Calls SDK Deploy API
  ↓
Monitors pipeline via pkg/progress/event.go
  ↓
Displays spinner with real-time status updates
  ↓
Shows endpoints via pkg/api/component/endpoint
```

--------------------------------

### Create Project Command

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/command-structure.md

Creates a new project with a specified name and organization.

```bash
bns projects create
  [--name <name>]
  [--organization <org-id>]
```

--------------------------------

### List Components Command

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/command-structure.md

Lists components within an environment, with optional pagination.

```bash
bns components list [<environment-id>]
  [--page <number>]
```

--------------------------------

### Variable API

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/api-client.md

Provides functions to interact with variables, including getting, listing, creating, and deleting them.

```APIDOC
## Variable API

### Description
Provides functions to interact with variables, including getting, listing, creating, and deleting them.

### Functions
- `Get(options *common.ItemOptions) (*sdk.VariableItem, error)`: Retrieves a single variable.
- `List(options *common.ListOptions) (*sdk.VariableListItem, error)`: Lists all variables.
- `Create(options *CreateOptions) (*sdk.VariableItem, error)`: Creates a new variable.
- `Delete(options *common.ItemOptions) (*sdk.VariableItem, error)`: Deletes a variable.
```

--------------------------------

### Get Template Definition API Function

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/api-client.md

Retrieves the definition of a specific template. Requires DefinitionOptions.

```go
func GetDefinition(options *DefinitionOptions) (*DefinitionResponse, error)
```

--------------------------------

### Get Component

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/component-api.md

Retrieves a single component by its ID. Requires options specifying the component ID.

```APIDOC
## Get Component

### Description
Retrieves a single component by ID.

### Method
GET (Assumed based on function name and typical SDK patterns)

### Endpoint
`/components/{component_id}` (Assumed based on function name and typical SDK patterns)

### Parameters
#### Path Parameters
- **component_id** (string) - Required - The ID of the component to retrieve.

#### Query Parameters
None explicitly documented.

#### Request Body
None explicitly documented.

### Request Example
```go
options := component.NewItemOptions("comp-123")
comp, err := component.Get(options)
if err != nil {
    return err
}
```

### Response
#### Success Response (200)
- **ComponentItem** (*sdk.ComponentItem) - The retrieved component data.

#### Response Example
(Response structure not explicitly defined in source, but would typically be a JSON object representing a component)

```

--------------------------------

### Create Environment Command

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/command-structure.md

Creates a new environment with specified name, project, and definition file.

```bash
bns environments create
  [--name <name>]
  [--project <project-id>]
  [--definition <definition-file>]
```

--------------------------------

### Get Environment Endpoints

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/environment-api.md

Retrieves all endpoints (exposed services) of an environment. Requires options with environment ID.

```APIDOC
## Get Environment Endpoints

### Description
Retrieves all endpoints (exposed services) of an environment.

### Method
(Not specified, likely a SDK method call)

### Parameters
#### Path Parameters
(None specified)

#### Query Parameters
(None specified)

#### Request Body
(None specified)

### Parameters
#### options (*common.ItemOptions) - Required - Options with environment ID

### Response
#### Success Response
- `[]*sdk.EnvironmentEndpoint` - List of endpoints
- `error` - Error if the operation fails

### Example
```go
options := environment.NewItemOptions("env-123")
endpoints, err := environment.GetEndpoints(options)
if err != nil {
    // Handle error
}
// endpoints contains the list of environment endpoints
```
```

--------------------------------

### Choose from a List of Options

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/interactive.md

Use Choose to prompt the user to select an item from a provided list of strings. It returns the index and the selected string, along with any potential error.

```Go
index, selected, err := interactive.Choose(
    "Select environment",
    []string{"dev", "staging", "production"},
)
if err != nil {
    log.Fatal(err)
}
fmt.Printf("Selected: %s (index: %d)\n", selected, index)
```

--------------------------------

### Key Dependencies

Source: https://github.com/bunnyshell/cli/blob/master/CLAUDE.md

List of core dependencies used in the project.

```text
bunnyshell.com/sdk (v0.20.4)          # HTTP API client
bunnyshell.com/dev (v0.7.2)           # Development utilities
github.com/spf13/cobra (v1.8.1)       # Command framework
github.com/spf13/viper (v1.19.0)      # Configuration
k8s.io/* (v0.30.2)                    # Kubernetes integration
```

--------------------------------

### Get Environment Endpoints

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/environment-api.md

Retrieves all endpoints (exposed services) of an environment. Requires options with the environment ID.

```go
func GetEndpoints(options *common.ItemOptions) ([]*sdk.EnvironmentEndpoint, error)
```

--------------------------------

### Get Component Resources

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/component-api.md

Retrieves resource allocation for a component. Requires options specifying the component ID.

```APIDOC
## Get Component Resources

### Description
Retrieves resource allocation for a component.

### Method
GET (Assumed based on function name and typical SDK patterns)

### Endpoint
`/components/{component_id}/resources` (Assumed based on function name and typical SDK patterns)

### Parameters
#### Path Parameters
- **component_id** (string) - Required - The ID of the component whose resources to retrieve.

#### Query Parameters
None explicitly documented.

#### Request Body
None explicitly documented.

### Request Example
```go
options := component.NewItemOptions("comp-123")
resources, err := component.GetResources(options)
if err != nil {
    return err
}
```

### Response
#### Success Response (200)
- **ComponentResources** (*ComponentResources) - Resource information for the component.
  - **CPU** (string) - CPU request/limit.
  - **Memory** (string) - Memory request/limit.
  - **Storage** (string) - Storage allocation.

#### Response Example
```json
{
  "CPU": "500m",
  "Memory": "1Gi",
  "Storage": "10Gi"
}
```

```

--------------------------------

### Create Resources in Bunnyshell CLI

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/command-structure.md

Use the 'create' command to provision new resources. Specify properties directly or allow interactive prompts for missing fields.

```bash
bns <resource> create
  [--name <name>]
  [--<property> <value>...]
```

--------------------------------

### Get Component Endpoints

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/component-api.md

Retrieves all endpoints exposed by a component. Requires options specifying the component ID.

```APIDOC
## Get Component Endpoints

### Description
Retrieves all endpoints exposed by a component.

### Method
GET (Assumed based on function name and typical SDK patterns)

### Endpoint
`/components/{component_id}/endpoints` (Assumed based on function name and typical SDK patterns)

### Parameters
#### Path Parameters
- **component_id** (string) - Required - The ID of the component whose endpoints to retrieve.

#### Query Parameters
None explicitly documented.

#### Request Body
None explicitly documented.

### Request Example
```go
options := component.NewItemOptions("comp-123")
endpoints, err := component.GetEndpoints(options)
if err != nil {
    return err
}
for _, ep := range endpoints {
    fmt.Printf("%s -> %s:%d\\n", ep.Name, ep.Host, ep.Port)
}
```

### Response
#### Success Response (200)
- **[]*sdk.ComponentEndpoint** - A list of endpoints exposed by the component.

#### Response Example
(Response structure not explicitly defined in source, but would typically be a JSON array of endpoint objects)

```

--------------------------------

### GetOptions Function

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/configuration-manager.md

Retrieves the current CLI options from the global manager.

```go
func GetOptions() *Options
```

--------------------------------

### Create New Manager Instance

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/configuration-manager.md

Creates a new instance of the configuration manager. The package also initializes a global singleton instance named `MainManager`.

```go
func NewManager() *Manager
```

--------------------------------

### List Environments Command

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/command-structure.md

Lists all environments, with optional pagination.

```bash
bns environments list
  [--page <number>]
```

--------------------------------

### Config Binding Flow

Source: https://github.com/bunnyshell/cli/blob/master/CLAUDE.md

Demonstrates how CLI flags are processed, including reading from config files, overriding with flags, and interactive prompting.

```go
// Flags automatically:
// 1. Read from config file
// 2. Overridden by CLI flags
// 3. Prompted interactively if missing
config.MainManager.CommandWithGlobalOptions(cmd)
```

--------------------------------

### Organization Context in Config File

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/configuration.md

Example of setting the organization context within a specific profile in the config.yaml file.

```yaml
profiles:
  myprofile:
    context:
      organization: org-12345
```

--------------------------------

### Template API

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/api-client.md

Provides functions for managing templates, including listing repositories, getting definitions, and generating content.

```APIDOC
## Template API

### Description
Provides functions for managing templates, including listing repositories, getting definitions, and generating content.

### Functions
- `Get(options *common.ItemOptions) (*sdk.TemplateItem, error)`: Retrieves a single template.
- `List(options *common.ListOptions) (*sdk.TemplateListItem, error)`: Lists all templates.
- `ListRepositories(options *common.ListOptions) (*RepositoryListResponse, error)`: Lists template repositories.
- `GetDefinition(options *DefinitionOptions) (*DefinitionResponse, error)`: Retrieves the definition of a template.
- `Generate(options *GenerateOptions) (*GenerateResponse, error)`: Generates content from a template.
```

--------------------------------

### GetSettings Function

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/configuration-manager.md

Retrieves the current runtime settings from the global manager.

```go
func GetSettings() *Settings
```

--------------------------------

### Pipeline API

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/api-client.md

Provides functions to interact with pipelines, including getting pipeline details and listing workflow jobs.

```APIDOC
## Pipeline API

### Description
Provides functions to interact with pipelines, including getting pipeline details and listing workflow jobs.

### Functions
- `Get(options *common.ItemOptions) (*sdk.DeploymentItem, error)`: Retrieves a single pipeline.
- `List(options *common.ListOptions) (*sdk.DeploymentListItem, error)`: Lists all pipelines.
- `GetWorkflowJobs(options *common.ItemOptions) (*sdk.WorkflowJobListItem, error)`: Retrieves workflow jobs for a pipeline.
```

--------------------------------

### Project Variable API

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/api-client.md

Provides functions to interact with project variables, including getting, listing, creating, and deleting them.

```APIDOC
## Project Variable API

### Description
Provides functions to interact with project variables, including getting, listing, creating, and deleting them.

### Functions
- `Get(options *common.ItemOptions) (*sdk.ProjectVariableItem, error)`: Retrieves a single project variable.
- `List(options *common.ListOptions) (*sdk.ProjectVariableListItem, error)`: Lists all project variables.
- `Create(options *CreateOptions) (*sdk.ProjectVariableItem, error)`: Creates a new project variable.
- `Delete(options *common.ItemOptions) (*sdk.ProjectVariableItem, error)`: Deletes a project variable.
```

--------------------------------

### List Projects Command

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/command-structure.md

Lists all projects, with options to filter by organization and paginate.

```bash
bns projects list
  [--organization <org-id>]
  [--page <number>]
```

--------------------------------

### Create Default List Options

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/api-client.md

Provides a constructor for ListOptions, initializing the page number to 1. Use this to easily create default pagination options for list requests.

```go
func NewListOptions() *ListOptions
```

--------------------------------

### Component Variable API

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/api-client.md

Provides functions to interact with component variables, including getting, listing, creating, and deleting them.

```APIDOC
## Component Variable API

### Description
Provides functions to interact with component variables, including getting, listing, creating, and deleting them.

### Functions
- `Get(options *common.ItemOptions) (*sdk.ComponentVariableItem, error)`: Retrieves a single component variable.
- `List(options *common.ListOptions) (*sdk.ComponentVariableListItem, error)`: Lists all component variables.
- `Create(options *CreateOptions) (*sdk.ComponentVariableItem, error)`: Creates a new component variable.
- `Delete(options *common.ItemOptions) (*sdk.ComponentVariableItem, error)`: Deletes a component variable.
```

--------------------------------

### Get Template API Function

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/api-client.md

Retrieves a single template item. Use for fetching details of a specific template.

```go
func Get(options *common.ItemOptions) (*sdk.TemplateItem, error)
```

--------------------------------

### Default Configuration Template

Source: https://github.com/bunnyshell/cli/blob/master/CLAUDE.md

Sample YAML structure for the CLI configuration file.

```yaml
defaultprofile: sample
outputformat: json
profiles:
  sample:
    token: ''
```

--------------------------------

### Implement Resource Formatter

Source: https://github.com/bunnyshell/cli/blob/master/AGENTS.md

Handles the tabulation of resource collections for CLI output.

```go
// pkg/formatter/stylish.resource.go
package formatter

import (
    "fmt"
    "text/tabwriter"
    "bunnyshell.com/sdk"
)

func tabulateResourceCollection(writer *tabwriter.Writer, data *sdk.PaginatedResourceCollection) {
    fmt.Fprintf(writer, "%v\t %v\t %v\n", "ID", "Name", "Status")

    if data.Embedded != nil {
        for _, item := range data.Embedded.Item {
            fmt.Fprintf(writer, "%v\t %v\t %v\n",
                item.GetId(),
                item.GetName(),
                item.GetStatus(),
            )
        }
    }
}
```

```go
case *sdk.PaginatedResourceCollection:
    tabulateResourceCollection(writer, dataType)
```

--------------------------------

### Get Environment Genesis Source

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/environment-api.md

Retrieves the Genesis source information for an environment. Requires options with environment ID.

```APIDOC
## Get Environment Genesis Source

### Description
Retrieves the Genesis source information for an environment.

### Method
(Not specified, likely a SDK method call)

### Parameters
#### Path Parameters
(None specified)

#### Query Parameters
(None specified)

#### Request Body
(None specified)

### Parameters
#### options (*common.ItemOptions) - Required - Options with environment ID

### Response
#### Success Response
- `interface{}` - Genesis source data
- `error` - Error if the operation fails

### Example
```go
options := environment.NewItemOptions("env-123")
gensisSource, err := environment.GetGenesisSource(options)
if err != nil {
    // Handle error
}
// gensisSource contains the Genesis source data
```
```

--------------------------------

### Get Organization API Function

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/api-client.md

Retrieves a single organization item. Use for fetching details of a specific organization.

```go
func Get(options *common.ItemOptions) (*sdk.OrganizationItem, error)
```

--------------------------------

### List Components with Pagination

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/component-api.md

Lists components with pagination, typically filtered by environment context. Use this to retrieve a paginated list of components.

```Go
options := common.NewListOptions()
components, err := component.List(options)
if err != nil {
    return err
}
for _, comp := range components.Embedded {
    fmt.Printf("Component: %s (%s)\n", comp.Name, comp.ID)
}
```

--------------------------------

### List Environments with Pagination

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/environment-api.md

Demonstrates how to list all environments by iterating through paginated results. It fetches environments page by page until all environments are retrieved.

```APIDOC
## List Environments with Pagination

### Description
This operation allows you to retrieve a list of environments. The results are paginated, and this example shows how to fetch all environments by making multiple requests.

### Method
GET (implied by `environment.List`)

### Endpoint
`/environments` (inferred)

### Parameters
#### Query Parameters
- **page** (int32) - Optional - The page number to retrieve.

### Request Example
```go
var allEnvs []*sdk.EnvironmentItem

for page := int32(1); ; page++ {
    options := common.NewListOptions()
    options.SetPage(page)
    
    items, err := environment.List(options)
    if err != nil {
        return err
    }
    
    allEnvs = append(allEnvs, items.Embedded...)
    
    if page >= items.Page+1 || items.Embedded == nil {
        break
    }
}
```

### Response
#### Success Response (200)
- **Embedded** ([]sdk.EnvironmentItem) - A list of environment items.
- **Page** (int32) - The current page number.

#### Response Example
```json
{
  "_embedded": [
    { "id": "env-1", "name": "Environment 1" },
    { "id": "env-2", "name": "Environment 2" }
  ],
  "page": 1
}
```
```

--------------------------------

### Get Event API Function

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/api-client.md

Retrieves a single event item. Use for fetching details of a specific event.

```go
func Get(options *common.ItemOptions) (*sdk.EventItem, error)
```

--------------------------------

### MainManager Singleton Instance

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/configuration-manager.md

Global singleton instance of the configuration manager, initialized at package load time.

```go
var MainManager = NewManager()
```

--------------------------------

### Get Environment Kubeconfig

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/environment-api.md

Retrieves the Kubernetes configuration for an environment's cluster. Requires options with environment ID.

```APIDOC
## Get Environment Kubeconfig

### Description
Retrieves the Kubernetes configuration for an environment's cluster.

### Method
(Not specified, likely a SDK method call)

### Parameters
#### Path Parameters
(None specified)

#### Query Parameters
(None specified)

#### Request Body
(None specified)

### Parameters
#### options (*common.ItemOptions) - Required - Options with environment ID

### Response
#### Success Response
- `string` - Kubeconfig YAML string
- `error` - Error if the operation fails

### Example
```go
options := environment.NewItemOptions("env-123")
kubeconfig, err := environment.GetKubeconfig(options)
if err != nil {
    return err
}
// Write to file or use for kubectl
os.WriteFile("kubeconfig.yaml", []byte(kubeconfig), 0600)
```
```

--------------------------------

### Get Full Workspace Directory Path

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/utilities.md

Returns the complete file system path for the Bunnyshell workspace directory.

```go
func GetWorkspaceDir() (string, error)
```

--------------------------------

### Implement CLI Command

Source: https://github.com/bunnyshell/cli/blob/master/AGENTS.md

Defines a new cobra command for listing resources, utilizing the resource API and pagination utilities.

```go
// cmd/[resource]/list.go
package resource

import (
    "bunnyshell.com/cli/pkg/api/resource"
    "bunnyshell.com/cli/pkg/lib"
    "github.com/spf13/cobra"
)

func init() {
    listOptions := resource.NewListOptions()

    command := &cobra.Command{
        Use: "list",
        Short: "List resources",
        ValidArgsFunction: cobra.NoFileCompletions,

        RunE: func(cmd *cobra.Command, args []string) error {
            return lib.ShowCollection(cmd, listOptions, func() (lib.ModelWithPagination, error) {
                return resource.List(listOptions)
            })
        },
    }

    flags := command.Flags()
    // Add your flags here
    listOptions.UpdateFlagSet(flags)

    mainCmd.AddCommand(command)
}
```

--------------------------------

### Get Environment Kubeconfig

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/environment-api.md

Retrieves the Kubernetes configuration for an environment's cluster. Requires options with the environment ID.

```go
func GetKubeconfig(options *common.ItemOptions) (string, error)
```

--------------------------------

### List Environments with Pagination

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/environment-api.md

Iterates through paginated results to fetch all environments. Breaks the loop when no more items are returned or the page count exceeds the total available pages.

```go
var allEnvs []*sdk.EnvironmentItem

for page := int32(1); ; page++ {
    options := common.NewListOptions()
    options.SetPage(page)
    
    items, err := environment.List(options)
    if err != nil {
        return err
    }
    
    allEnvs = append(allEnvs, items.Embedded...)
    
    if page >= items.Page+1 || items.Embedded == nil {
        break
    }
}
```

--------------------------------

### Get Remote Development Profile

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/component-api.md

Retrieves remote development profile for a component. Requires RdevProfileOptions with the component ID.

```Go
type RdevProfileOptions struct {
    Options
    ComponentID string
}
```

--------------------------------

### Deploy Environment

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/environment-api.md

Deploys an environment, initiating a deployment pipeline.

```APIDOC
## Deploy Environment

### Description
Deploys an environment, creating a deployment pipeline.

### Method
POST (assumed based on function name and typical SDK patterns)

### Endpoint
`/environments/{environment_id}/deploy` (inferred)

### Parameters
#### Path Parameters
- **environment_id** (string) - Required - The ID of the environment to deploy.

#### Query Parameters
None explicitly documented.

#### Request Body
- **WithoutPipeline** (bool) - Optional - Skip pipeline creation.
- **Interval** (time.Duration) - Optional - Polling interval for pipeline.
- **Watch** (bool) - Optional - Monitor deployment.

### Request Example
```go
deployOpts := &environment.DeployOptions{
    ID:    "env-123",
    Watch: true,
}
deployment, err := environment.Deploy(deployOpts)
if err != nil {
    return err
}
```

### Response
#### Success Response (200)
- **sdk.DeploymentItem** - The deployment or pipeline information.

#### Response Example
(Response structure not explicitly provided in source, but would typically be a JSON object representing the deployment status)
```

--------------------------------

### Get Remote Development Configuration

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/component-api.md

Retrieves remote development configuration for a component. Requires RdevConfigOptions with the component ID.

```Go
type RdevConfigOptions struct {
    Options
    ComponentID string
}
```

--------------------------------

### Test CLI Build

Source: https://github.com/bunnyshell/cli/blob/master/CLAUDE.md

Verifies the generated binaries from the host or container.

```bash
# From container: ./dist/bns_linux_amd64_v1/bns --help
# From host (macOS): ./dist/bns_darwin_arm64/bns --help or ./dist/bns_darwin_amd64_v1/bns --help
```

--------------------------------

### Get a Single Component

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/component-api.md

Retrieves a single component by its ID. Use this when you need to fetch details for a specific component.

```Go
options := component.NewItemOptions("comp-123")
comp, err := component.Get(options)
if err != nil {
    return err
}
```

--------------------------------

### Programmatic Formatting with Bunnyshell CLI

Source: https://github.com/bunnyshell/cli/blob/master/_autodocs/api-reference/formatter.md

Shows how to use the Bunnyshell CLI's formatter package to format environment data according to user settings. It retrieves settings, applies the formatter, and prints the output.

```go
package main

import (
    "fmt"
    "bunnyshell.com/cli/pkg/config"
    "bunnyshell.com/cli/pkg/formatter"
)

func printEnvironment(env interface{}) error {
    settings := config.GetSettings()
    output, err := formatter.Formatter(env, settings.OutputFormat)
    if err != nil {
        return err
    }
    fmt.Println(string(output))
    return nil
}
```