project

Documentation

Index

• Variables
• func DeleteDeployment(ctx context.Context, logger logger.Logger, baseUrl string, token string, ...) error
• func DeleteProjectEnv(ctx context.Context, logger logger.Logger, baseUrl string, token string, ...) error
• func DeleteProjects(ctx context.Context, logger logger.Logger, baseUrl string, token string, ...) ([]string, error)
• func NewProject() *project.Project
• func ProjectWithNameExists(ctx context.Context, logger logger.Logger, baseUrl string, token string, ...) (bool, error)
• func RemoveEnvValues(ctx context.Context, logger logger.Logger, dir string, keys ...string) error
• func ResolveProjectDir(logger logger.Logger, cmd *cobra.Command, required bool) string
• func RollbackDeployment(ctx context.Context, logger logger.Logger, baseUrl string, token string, ...) error
• func SaveEnvValue(ctx context.Context, logger logger.Logger, dir string, ...) error
• type AgentBundlerConfig
• type Bundler
• type DeploymentConfig
  • func NewDeploymentConfig() *DeploymentConfig
  • func (c *DeploymentConfig) Write(logger logger.Logger, dir string) error
• type DeploymentListData
  • func ListDeployments(ctx context.Context, logger logger.Logger, baseUrl string, token string, ...) ([]DeploymentListData, error)
• type InitProjectArgs
• type ProjectContext
  • func EnsureProject(ctx context.Context, cmd *cobra.Command) ProjectContext
  • func LoadProject(logger logger.Logger, dir string, apiUrl string, appUrl string, ...) ProjectContext
  • func TryProject(ctx context.Context, cmd *cobra.Command) ProjectContext
• type ProjectData
  • func GetProject(ctx context.Context, logger logger.Logger, baseUrl string, token string, ...) (*ProjectData, error)
  • func InitProject(ctx context.Context, logger logger.Logger, args InitProjectArgs) (*ProjectData, error)
  • func SetProjectEnv(ctx context.Context, logger logger.Logger, baseUrl string, token string, ...) (*ProjectData, error)
• type ProjectImportRequest
• type ProjectImportResponse
  • func ProjectImport(ctx context.Context, logger logger.Logger, baseUrl string, token string, ...) (*ProjectImportResponse, error)
• type ProjectListData
  • func ListProjects(ctx context.Context, logger logger.Logger, baseUrl string, token string) ([]ProjectListData, error)
• type ProjectResponse
• type Response

Variables

var Version string

Functions

func DeleteDeployment

func DeleteDeployment(ctx context.Context, logger logger.Logger, baseUrl string, token string, projectId string, deploymentId string) error

func DeleteProjectEnv

func DeleteProjectEnv(ctx context.Context, logger logger.Logger, baseUrl string, token string, projectId string, env []string, secrets []string) error

func DeleteProjects

func DeleteProjects(ctx context.Context, logger logger.Logger, baseUrl string, token string, ids []string) ([]string, error)

func NewProject

func NewProject() *project.Project

NewProject will create a new project that is empty.

func ProjectWithNameExists

func ProjectWithNameExists(ctx context.Context, logger logger.Logger, baseUrl string, token string, orgId string, name string) (bool, error)

func RemoveEnvValues

func RemoveEnvValues(ctx context.Context, logger logger.Logger, dir string, keys ...string) error

func ResolveProjectDir

func ResolveProjectDir(logger logger.Logger, cmd *cobra.Command, required bool) string

func RollbackDeployment

func RollbackDeployment(ctx context.Context, logger logger.Logger, baseUrl string, token string, projectId string, deploymentId string) error

func SaveEnvValue

func SaveEnvValue(ctx context.Context, logger logger.Logger, dir string, keyvalues map[string]string) error

Types

type AgentBundlerConfig

type AgentBundlerConfig struct {
	Dir string `yaml:"dir" json:"dir"`
}

type Bundler

type Bundler struct {
	Enabled     bool               `yaml:"enabled" json:"enabled"`
	Identifier  string             `yaml:"identifier" json:"identifier"`
	Language    string             `yaml:"language" json:"language"`
	Framework   string             `yaml:"framework,omitempty" json:"framework,omitempty"`
	Runtime     string             `yaml:"runtime,omitempty" json:"runtime,omitempty"`
	AgentConfig AgentBundlerConfig `yaml:"agents" json:"agents"`
	Ignore      []string           `yaml:"ignore,omitempty" json:"ignore,omitempty"`
	CLIVersion  string             `yaml:"-" json:"-"`
}

type DeploymentConfig

type DeploymentConfig struct {
	Provider   string   `yaml:"provider" json:"provider"`
	Language   string   `yaml:"language" json:"language"`
	Runtime    string   `yaml:"runtime,omitempty" json:"runtime,omitempty"`
	MinVersion string   `yaml:"min_version,omitempty" json:"min_version,omitempty"` // FIXME
	WorkingDir string   `yaml:"working_dir,omitempty" json:"working_dir,omitempty"`
	Command    []string `yaml:"command,omitempty" json:"command,omitempty"`
	Env        []string `yaml:"env,omitempty" json:"env,omitempty"`
}

func NewDeploymentConfig

func NewDeploymentConfig() *DeploymentConfig

func (*DeploymentConfig) Write

func (c *DeploymentConfig) Write(logger logger.Logger, dir string) error

type DeploymentListData

type DeploymentListData struct {
	ID        string   `json:"id"`
	Message   string   `json:"message"`
	Tags      []string `json:"tags"`
	Active    bool     `json:"active"`
	CreatedAt string   `json:"createdAt"`
}

func ListDeployments

func ListDeployments(ctx context.Context, logger logger.Logger, baseUrl string, token string, projectId string) ([]DeploymentListData, error)

type InitProjectArgs

type InitProjectArgs struct {
	BaseURL           string
	Dir               string
	Token             string
	OrgId             string
	Provider          string
	Name              string
	Description       string
	EnableWebhookAuth bool
	Agents            []project.AgentConfig
	AuthType          string
	Framework         string
}

type ProjectContext

type ProjectContext struct {
	Logger       logger.Logger
	Project      *project.Project
	Dir          string
	APIURL       string
	APPURL       string
	TransportURL string
	Token        string
	NewProject   bool
}

func EnsureProject

func EnsureProject(ctx context.Context, cmd *cobra.Command) ProjectContext

func LoadProject

func LoadProject(logger logger.Logger, dir string, apiUrl string, appUrl string, transportUrl, token string) ProjectContext

func TryProject

func TryProject(ctx context.Context, cmd *cobra.Command) ProjectContext

type ProjectData

type ProjectData struct {
	APIKey           string                `json:"api_key"`
	ProjectKey       string                `json:"projectKey"`
	ProjectId        string                `json:"id"`
	OrgId            string                `json:"orgId"`
	Env              map[string]string     `json:"env"`
	Secrets          map[string]string     `json:"secrets"`
	WebhookAuthToken string                `json:"webhookAuthToken,omitempty"`
	Agents           []project.AgentConfig `json:"agents"`
}

func GetProject

func GetProject(ctx context.Context, logger logger.Logger, baseUrl string, token string, projectId string, shouldMask bool, includeProjectKeys bool) (*ProjectData, error)

func InitProject

func InitProject(ctx context.Context, logger logger.Logger, args InitProjectArgs) (*ProjectData, error)

InitProject will create a new project in the organization. It will return the API key and project ID if the project is initialized successfully.

func SetProjectEnv

func SetProjectEnv(ctx context.Context, logger logger.Logger, baseUrl string, token string, projectId string, env map[string]string, secrets map[string]string) (*ProjectData, error)

type ProjectImportRequest

type ProjectImportRequest struct {
	Name                string                `json:"name"`
	Description         string                `json:"description"`
	Provider            string                `json:"provider"`
	OrgId               string                `json:"orgId"`
	Agents              []project.AgentConfig `json:"agents"`
	EnableWebhookAuth   bool                  `json:"enableWebhookAuth"`
	CopiedFromProjectId string                `json:"copiedFromProjectId"`
}

type ProjectImportResponse

type ProjectImportResponse struct {
	ID          string                `json:"id"`
	Agents      []project.AgentConfig `json:"agents"`
	APIKey      string                `json:"apiKey"`
	ProjectKey  string                `json:"projectKey"`
	IOAuthToken string                `json:"ioAuthToken"`
}

func ProjectImport

func ProjectImport(ctx context.Context, logger logger.Logger, baseUrl string, token string, orgId string, p *project.Project, enableWebhookAuth bool) (*ProjectImportResponse, error)

type ProjectListData

type ProjectListData struct {
	ID          string `json:"id"`
	Name        string `json:"name"`
	Description string `json:"description"`
	OrgId       string `json:"orgId"`
	OrgName     string `json:"orgName"`
}

func ListProjects

func ListProjects(ctx context.Context, logger logger.Logger, baseUrl string, token string) ([]ProjectListData, error)

type ProjectResponse

type ProjectResponse = Response[ProjectData]

type Response

type Response[T any] struct {
	Success bool   `json:"success"`
	Message string `json:"message"`
	Data    T      `json:"data"`
}