environment

package

v0.0.0 Latest Latest Go to latest Published: Jun 9, 2025 License: Apache-2.0 Imports: 17 Imported by: 0

Details

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

Repository

github.com/dagger/container-use

Links

Documentation ¶

Index ¶

func Initialize(client *dagger.Client) error
func InitializeLocalRemote(ctx context.Context, localRepoPath string) (string, error)
type EndpointMapping
type EndpointMappings
type Environment
type History
- func StateFromCommit(ctx context.Context, repoDir, commit string) (History, error)
type Revision
type Version

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Initialize ¶

func Initialize(client *dagger.Client) error

func InitializeLocalRemote ¶

func InitializeLocalRemote(ctx context.Context, localRepoPath string) (string, error)

Types ¶

type EndpointMapping ¶

type EndpointMapping struct {
	Internal string `json:"internal"`
	External string `json:"external"`
}

type EndpointMappings ¶

type EndpointMappings map[int]*EndpointMapping

type Environment ¶

type Environment struct {
	ID       string `json:"-"`
	Name     string `json:"-"`
	Source   string `json:"-"`
	Worktree string `json:"-"`

	Instructions  string   `json:"-"`
	Workdir       string   `json:"workdir"`
	BaseImage     string   `json:"base_image"`
	SetupCommands []string `json:"setup_commands,omitempty"`
	Secrets       []string `json:"secrets,omitempty"`

	History History `json:"-"`
	// contains filtered or unexported fields
}

func Create ¶

func Create(ctx context.Context, explanation, source, name string) (*Environment, error)

func Get ¶

func Get(idOrName string) *Environment

func List ¶

func List() []*Environment

func Open ¶

func Open(ctx context.Context, explanation, source, id string) (*Environment, error)

func (*Environment) Checkpoint ¶

func (env *Environment) Checkpoint(ctx context.Context, target string) (string, error)

func (*Environment) Delete ¶

func (env *Environment) Delete(ctx context.Context) error

func (*Environment) DeleteLocalRemoteBranch ¶

func (env *Environment) DeleteLocalRemoteBranch() error

func (*Environment) DeleteWorktree ¶

func (env *Environment) DeleteWorktree() error

func (*Environment) Download ¶

func (s *Environment) Download(ctx context.Context, source string, target string) error

func (*Environment) FileDelete ¶

func (s *Environment) FileDelete(ctx context.Context, explanation, targetFile string) error

func (*Environment) FileList ¶

func (s *Environment) FileList(ctx context.Context, path string) (string, error)

func (*Environment) FileRead ¶

func (s *Environment) FileRead(ctx context.Context, targetFile string, shouldReadEntireFile bool, startLineOneIndexed int, endLineOneIndexedInclusive int) (string, error)

func (*Environment) FileWrite ¶

func (s *Environment) FileWrite(ctx context.Context, explanation, targetFile, contents string) error

func (*Environment) Fork ¶

func (env *Environment) Fork(ctx context.Context, explanation, name string, version *Version) (*Environment, error)

func (*Environment) GetWorktreePath ¶

func (env *Environment) GetWorktreePath() (string, error)

func (*Environment) InitializeWorktree ¶

func (env *Environment) InitializeWorktree(ctx context.Context, localRepoPath string) (string, error)

func (*Environment) RemoteDiff ¶

func (s *Environment) RemoteDiff(ctx context.Context, source string, target string) (string, error)

func (*Environment) Revert ¶

func (env *Environment) Revert(ctx context.Context, explanation string, version Version) error

func (*Environment) RevisionDiff ¶

func (s *Environment) RevisionDiff(ctx context.Context, path string, fromVersion, toVersion Version) (string, error)

func (*Environment) Run ¶

func (env *Environment) Run(ctx context.Context, explanation, command, shell string, useEntrypoint bool) (string, error)

func (*Environment) RunBackground ¶

func (env *Environment) RunBackground(ctx context.Context, explanation, command, shell string, ports []int, useEntrypoint bool) (EndpointMappings, error)

func (*Environment) SetEnv ¶

func (env *Environment) SetEnv(ctx context.Context, explanation string, envs []string) error

func (*Environment) Terminal ¶

func (env *Environment) Terminal(ctx context.Context) error

func (*Environment) Update ¶

func (env *Environment) Update(ctx context.Context, explanation, instructions, baseImage string, setupCommands, secrets []string) error

func (*Environment) Upload ¶

func (s *Environment) Upload(ctx context.Context, explanation, source string, target string) error

type History ¶

type History []*Revision

func StateFromCommit ¶

func StateFromCommit(ctx context.Context, repoDir, commit string) (History, error)

func (History) Get ¶

func (h History) Get(version Version) *Revision

func (History) Latest ¶

func (h History) Latest() *Revision

func (History) LatestVersion ¶

func (h History) LatestVersion() Version

type Revision ¶

type Revision struct {
	Version     Version   `json:"version"`
	Name        string    `json:"name"`
	Explanation string    `json:"explanation"`
	Output      string    `json:"output,omitempty"`
	CreatedAt   time.Time `json:"created_at"`
	State       string    `json:"state"`
	// contains filtered or unexported fields
}

type Version ¶

type Version int

Source Files ¶

View all Source files

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