cmd

Documentation

Index

• Variables
• func Execute()
• type DevxConfig
• type DevxConfigDatabase
• type DevxConfigMock
• type DevxConfigTest
• type DevxConfigTestUI
• type DevxConfigTunnel

Variables

var DryRun bool

var NonInteractive bool

Functions

func Execute

func Execute()

Types

type DevxConfig

type DevxConfig struct {
	Name      string               `yaml:"name"`      // Project name
	Domain    string               `yaml:"domain"`    // Custom domain (BYOD)
	Tunnels   []DevxConfigTunnel   `yaml:"tunnels"`   // List of ports to expose
	Databases []DevxConfigDatabase `yaml:"databases"` // List of databases to provision
	Test      DevxConfigTest       `yaml:"test"`      // Test configuration
	Mocks     []DevxConfigMock     `yaml:"mocks"`     // List of OpenAPI mock servers to provision
}

type DevxConfigDatabase

type DevxConfigDatabase struct {
	Engine string `yaml:"engine"`
	Port   int    `yaml:"port"`
}

type DevxConfigMock

type DevxConfigMock struct {
	Name string `yaml:"name"` // Friendly name (becomes env var MOCK_<NAME>_URL)
	URL  string `yaml:"url"`  // Remote OpenAPI spec URL (must be http:// or https://)
	Port int    `yaml:"port"` // Host port (0 = auto-assign a free port)
}

DevxConfigMock defines a remote OpenAPI-backed mock server entry. TODO(future): support local file specs by detecting if URL is a file:// or relative path, then volume-mounting it into the Prism container.

type DevxConfigTest

type DevxConfigTest struct {
	UI DevxConfigTestUI `yaml:"ui"`
}

type DevxConfigTestUI

type DevxConfigTestUI struct {
	Setup   string `yaml:"setup"`   // Pre-processing steps (e.g., migrations) to run before tests
	Command string `yaml:"command"` // The actual test command to execute
}

type DevxConfigTunnel

type DevxConfigTunnel struct {
	Name      string `yaml:"name"`       // Subdomain explicitly requested
	Port      int    `yaml:"port"`       // Local port to forward traffic towards
	BasicAuth string `yaml:"basic_auth"` // basic auth literal value 'user:pass'
	Throttle  string `yaml:"throttle"`   // traffic shaping profile e.g. '3g'
}