exporter

package

v1.4.14 Latest Latest Go to latest Published: Oct 12, 2026 License: MIT Imports: 32 Imported by: 0

Details

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

Repository

github.com/nself-org/cli

Links

Open Source Insights

Documentation ¶

Rendered for

Overview ¶

Package exporter writes a read-only, snapshot-consistent portable bundle.

Index ¶

type Options
type Summary
- func Export(ctx context.Context, cfg *config.Config, opts Options) (Summary, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Options ¶

type Options struct {
	Out          string
	Schemas      []string
	NoStorage    bool
	SecretValues []string
	Keys         []string
	ProjectDir   string
	FreeSpace    func(string) (uint64, error)
	// Warn receives non-secret preflight warnings; nil means os.Stderr.
	Warn io.Writer
}

Options describes an export. FreeSpace is a test seam, never an env override. SecretValues and Keys come from the resolved environment, not raw env files.

type Summary ¶

type Summary struct {
	Out         string `json:"out"`
	Tables      int    `json:"tables"`
	Users       int    `json:"users"`
	Objects     int    `json:"objects"`
	StorageNote string `json:"storage_note"`
}

Summary is the command's envelope data; it never includes credentials.

func Export ¶

func Export(ctx context.Context, cfg *config.Config, opts Options) (Summary, error)

Purpose: preflight, extract, scrub and publish a bundle. Inputs: loaded project config and options. Outputs: counts or a safe error. Constraints: no source writes; temporary output is removed on every failure.

Source Files ¶

View all Source files

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