cli

package

v0.2.9 Latest Latest Go to latest Published: Jan 13, 2022 License: Apache-2.0 Imports: 19 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/arken/arken

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

View Source

var Daemon = cmd.Sub{
	Name:  "daemon",
	Alias: "d",
	Short: "Startup and run the Arken daemon.",
	Run:   RunDaemon,
}

View Source

var Init = cmd.Sub{
	Name:  "init",
	Alias: "i",
	Short: "Initialize Arken's configuration without running the daemon.",
	Run:   RunInit,
}

View Source

var Root = &cmd.Root{
	Name:    "arken",
	Short:   "Arken is a distributed archive system.",
	Version: config.Version,
	License: "Licensed under the Apache License, Version 2.0",
	Flags:   &GlobalFlags{},
}

View Source

var Update = cmd.Sub{
	Name:  "update",
	Alias: "upd",
	Short: "Update Arken to the latest version available.",
	Args:  &UpdateArgs{},
	Flags: &UpdateFlags{},
	Run:   UpdateRun,
}

Update checks for a new version of the Arken program and updates itself if a newer version is found and the user agrees to update.

Functions ¶

func RunDaemon ¶

func RunDaemon(r *cmd.Root, s *cmd.Sub)

func RunInit ¶

func RunInit(r *cmd.Root, s *cmd.Sub)

func UpdateRun ¶ added in v0.2.2

func UpdateRun(r *cmd.Root, c *cmd.Sub)

UpdateRun handles the checking and self updating of the Arken program.

Types ¶

type GlobalFlags ¶

type GlobalFlags struct {
	Config  string `short:"c" long:"config" desc:"Specify a custom config path."`
	Verbose bool   `short:"v" long:"verbose" desc:"Show More Information"`
}

GlobalFlags contains the flags for commands.

type UpdateArgs ¶ added in v0.2.2

type UpdateArgs struct {
}

UpdateArgs handles the specific arguments for the update command.

type UpdateFlags ¶ added in v0.2.2

type UpdateFlags struct {
	Yes bool `short:"y" long:"yes" desc:"If a newer version is found update without prompting the user."`
}

UpdateFlags handles the specific flags for the update command.

Source Files ¶

View all Source files

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