cli

package

v0.2.0 Latest Latest Go to latest Published: May 18, 2026 License: Apache-2.0 Imports: 21 Imported by: 0

Details

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

Repository

github.com/edithatogo/osf-cli-go

Links

Open Source Insights

Documentation ¶

Overview ¶

Package cli builds and executes the osf command tree.

Index ¶

func Run(args []string, stdout io.Writer, stderr io.Writer) int
func WithSignal(ctx context.Context) context.Context
type ExportData
type ProgressWriter
- func NewProgressWriter(w io.Writer) *ProgressWriter
- func (pw *ProgressWriter) Finish()
- func (pw *ProgressWriter) Write(p []byte) (int, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Run ¶

func Run(args []string, stdout io.Writer, stderr io.Writer) int

Run executes the osf CLI and returns a process exit code.

func WithSignal ¶

func WithSignal(ctx context.Context) context.Context

Types ¶

type ExportData ¶

type ExportData struct {
	Node         projectRecord   `json:"node"`
	Contributors []projectRecord `json:"contributors,omitempty"`
	Files        []fileRecord    `json:"files,omitempty"`
	Components   []projectRecord `json:"components,omitempty"`
}

ExportData holds a full snapshot of a node's data.

type ProgressWriter ¶

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

func NewProgressWriter ¶

func NewProgressWriter(w io.Writer) *ProgressWriter

func (*ProgressWriter) Finish ¶

func (pw *ProgressWriter) Finish()

func (*ProgressWriter) Write ¶

func (pw *ProgressWriter) Write(p []byte) (int, error)

Source Files ¶

View all Source files

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