cmd

package

v0.1.0-alpha.15 Latest Latest Go to latest Published: Jun 18, 2025 License: Apache-2.0 Imports: 29 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/stainless-api/stainless-api-cli

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func CheckInteractiveAndInitWorkspace(cmd *cli.Command, projectName string)
func ColorizeJSON(input string, w io.Writer) string
func ConfigDir() (string, error)
func GetFormKeyMap() *huh.KeyMap
func GetFormTheme() *huh.Theme
func GetProjectName(cmd *cli.Command, flagName string) string
func SaveAuthConfig(config *AuthConfig) error
func Spacer()
type AuthConfig
- func LoadAuthConfig() (*AuthConfig, error)
- func StartDeviceFlow(clientID, scope string) (*AuthConfig, error)
type Group
type WorkspaceConfig
- func NewWorkspaceConfig(projectName, openAPISpec, stainlessConfig string) (*WorkspaceConfig, error)

Constants ¶

View Source

const Version = "0.0.1-alpha.0" // x-release-please-version

Variables ¶

View Source

var Command = cli.Command{
	Name:    "stl",
	Usage:   "CLI for the stainless API",
	Version: Version,
	Flags: []cli.Flag{
		&cli.BoolFlag{
			Name:  "debug",
			Usage: "Enable debug logging",
		},
	},
	Commands: []*cli.Command{
		{
			Name: "auth",
			Commands: []*cli.Command{
				&authLogin,
				&authLogout,
				&authStatus,
			},
		},

		{
			Name: "workspace",
			Commands: []*cli.Command{
				&workspaceInit,
				&workspaceStatus,
			},
		},

		{
			Name: "projects",
			Commands: []*cli.Command{
				&projectsCreate,
				&projectsRetrieve,
				&projectsUpdate,
				&projectsList,
			},
		},

		{
			Name: "projects:branches",
			Commands: []*cli.Command{
				&projectsBranchesCreate,
				&projectsBranchesRetrieve,
			},
		},

		{
			Name: "projects:configs",
			Commands: []*cli.Command{
				&projectsConfigsRetrieve,
				&projectsConfigsGuess,
			},
		},

		{
			Name: "builds",
			Commands: []*cli.Command{
				&buildsCreate,
				&buildsRetrieve,
				&buildsList,
				&buildsCompare,
			},
		},

		{
			Name: "builds:target_outputs",
			Commands: []*cli.Command{
				&buildsTargetOutputsRetrieve,
			},
		},

		{
			Name: "orgs",
			Commands: []*cli.Command{
				&orgsRetrieve,
				&orgsList,
			},
		},
	},
	EnableShellCompletion: true,
	HideHelpCommand:       true,
}

Functions ¶

func CheckInteractiveAndInitWorkspace ¶

func CheckInteractiveAndInitWorkspace(cmd *cli.Command, projectName string)

CheckInteractiveAndInitWorkspace checks if running in interactive mode and prompts to init workspace if needed

func ColorizeJSON ¶

func ColorizeJSON(input string, w io.Writer) string

func ConfigDir ¶

func ConfigDir() (string, error)

ConfigDir returns the directory where config files are stored

func GetFormKeyMap ¶

func GetFormKeyMap() *huh.KeyMap

GetFormKeyMap returns the standard huh keymap used across all forms

func GetFormTheme ¶

func GetFormTheme() *huh.Theme

GetFormTheme returns the standard huh theme used across all forms

func GetProjectName ¶

func GetProjectName(cmd *cli.Command, flagName string) string

GetProjectName returns the project name from the command line flag or workspace config

func SaveAuthConfig ¶

func SaveAuthConfig(config *AuthConfig) error

SaveAuthConfig saves the auth config to disk

func Spacer ¶

func Spacer()

Types ¶

type AuthConfig ¶

type AuthConfig struct {
	AccessToken  string `json:"access_token"`
	RefreshToken string `json:"refresh_token,omitempty"`
	TokenType    string `json:"token_type"`
}

AuthConfig stores the OAuth credentials

func LoadAuthConfig ¶

func LoadAuthConfig() (*AuthConfig, error)

LoadAuthConfig loads the auth config from disk

func StartDeviceFlow ¶

func StartDeviceFlow(clientID, scope string) (*AuthConfig, error)

StartDeviceFlow initiates the OAuth 2.0 device flow

type Group ¶

type Group struct {
	// contains filtered or unexported fields
}

Group represents a nested logging group

func Error ¶

func Error(format string, args ...any) Group

func Info ¶

func Info(format string, args ...any) Group

func Progress ¶

func Progress(format string, args ...any) Group

func Property ¶

func Property(key, msg string) Group

func Success ¶

func Success(format string, args ...any) Group

func Warn ¶

func Warn(format string, args ...any) Group

func (Group) Error ¶

func (g Group) Error(format string, args ...any) Group

func (Group) Info ¶

func (g Group) Info(format string, args ...any) Group

func (Group) Progress ¶

func (g Group) Progress(format string, args ...any) Group

func (Group) Property ¶

func (g Group) Property(key, msg string) Group

func (Group) Success ¶

func (g Group) Success(format string, args ...any) Group

func (Group) Warn ¶

func (g Group) Warn(format string, args ...any) Group

type WorkspaceConfig ¶

type WorkspaceConfig struct {
	Project         string `json:"project"`
	OpenAPISpec     string `json:"openapi_spec,omitempty"`
	StainlessConfig string `json:"stainless_config,omitempty"`

	ConfigPath string `json:"-"`
}

WorkspaceConfig stores workspace-level configuration

func NewWorkspaceConfig ¶

func NewWorkspaceConfig(projectName, openAPISpec, stainlessConfig string) (*WorkspaceConfig, error)

func (*WorkspaceConfig) Find ¶

func (config *WorkspaceConfig) Find() (bool, error)

Find searches for a stainless-workspace.json file starting from the current directory and moving up to parent directories until found or root is reached

func (*WorkspaceConfig) Load ¶

func (config *WorkspaceConfig) Load(configPath string) error

func (*WorkspaceConfig) Save ¶

func (config *WorkspaceConfig) Save() error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL