themeinstall

package

v0.3.0 Latest Latest Go to latest Published: Oct 19, 2026 License: MIT Imports: 7 Imported by: 0

Details

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

Repository

github.com/umono-cms/cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package themeinstall installs a built theme into a Umono project.

Index ¶

Variables
type Options
type Result
- func Install(projectDir, file string, opts Options) (Result, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrCLIOutdated      = errors.New("the CLI is out of date and cannot verify this theme; upgrade the CLI")
	ErrAlreadyInstalled = errors.New("the theme is already installed; use --force to reinstall it")
	ErrIncompatibleAPI  = errors.New("the theme's Theme API version is outside the range of this Umono; use --allow-incompatible-api to install it anyway")
)

Functions ¶

This section is empty.

Types ¶

type Options ¶

type Options struct {
	// Force reinstalls an installed theme. The installed directory is not
	// touched: the package goes to themes-pending/ and waits for the site
	// owner's approval in the admin panel.
	Force bool
	// AllowIncompatibleAPI installs a theme whose theme-api-version is
	// outside the range in umono.json. It does not cover ErrCLIOutdated.
	AllowIncompatibleAPI bool
}

Options are the flags of umono theme install.

func Install ¶

func Install(projectDir, file string, opts Options) (Result, error)

Install checks the built file and installs it into the Umono project projectDir as themes/{org}/{id}/{version}/. It runs the themecore checks of activation in the same order; the checks that need the database or the network are the runtime's. Nothing is written before every check has passed.

Source Files ¶

View all Source files

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