cli

package

v0.3.0 Latest Latest Go to latest Published: Feb 26, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

Details

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

Repository

github.com/jlrickert/tapper

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func NewBacklinksCmd(deps *Deps) *cobra.Command
func NewCatCmd(deps *Deps) *cobra.Command
func NewConfigCmd(deps *Deps) *cobra.Command
func NewCreateCmd(deps *Deps) *cobra.Command
func NewEditCmd(deps *Deps) *cobra.Command
func NewFileCmd(deps *Deps) *cobra.Command
func NewGrepCmd(deps *Deps) *cobra.Command
func NewImageCmd(deps *Deps) *cobra.Command
func NewIndexCmd(deps *Deps) *cobra.Command
func NewInfoCmd(deps *Deps) *cobra.Command
func NewInitCmd(deps *Deps) *cobra.Command
func NewListCmd(deps *Deps) *cobra.Command
func NewMetaCmd(deps *Deps) *cobra.Command
func NewMoveCmd(deps *Deps) *cobra.Command
func NewPwdCmd(deps *Deps) *cobra.Command
func NewReindexCmd(deps *Deps) *cobra.Command
func NewRemoveCmd(deps *Deps) *cobra.Command
func NewRepoCmd(deps *Deps) *cobra.Command
func NewRepoConfigCmd(deps *Deps) *cobra.Command
func NewRepoConfigEditCmd(deps *Deps) *cobra.Command
func NewRepoKegListCmd(deps *Deps) *cobra.Command
func NewRootCmd(deps *Deps) *cobra.Command
func NewStatsCmd(deps *Deps) *cobra.Command
func NewTagsCmd(deps *Deps) *cobra.Command
func Run(ctx context.Context, rt *toolkit.Runtime, args []string) (int, error)
func RunWithProfile(ctx context.Context, rt *toolkit.Runtime, args []string, profile Profile) (int, error)
type Deps
type Profile
- func KegV2Profile() Profile
- func TapProfile() Profile

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	Version string = "dev"
)

Functions ¶

func NewBacklinksCmd ¶

func NewBacklinksCmd(deps *Deps) *cobra.Command

func NewCatCmd ¶

func NewCatCmd(deps *Deps) *cobra.Command

NewCatCmd returns the `cat` cobra command.

Usage examples:

tap cat 0
tap cat 0 1 2
tap cat --tag "fire and not archived"
tap cat 0 --keg myalias

func NewConfigCmd ¶

func NewConfigCmd(deps *Deps) *cobra.Command

NewConfigCmd returns the `config` cobra command.

Usage examples:

tap config
tap config --keg myalias
tap config --edit
tap config --edit --keg myalias

func NewCreateCmd ¶

func NewCreateCmd(deps *Deps) *cobra.Command

NewCreateCmd constructs the `create` subcommand.

Usage examples:

Tap create --title "My note" --lead "one-line summary"
Tap create --title "Note" --tags tag1 --tags tag2 --attrs foo=bar --attrs x=1

func NewEditCmd ¶

func NewEditCmd(deps *Deps) *cobra.Command

NewEditCmd returns the `edit` cobra command.

func NewFileCmd ¶ added in v0.2.0

func NewFileCmd(deps *Deps) *cobra.Command

func NewGrepCmd ¶

func NewGrepCmd(deps *Deps) *cobra.Command

func NewImageCmd ¶ added in v0.2.0

func NewImageCmd(deps *Deps) *cobra.Command

func NewIndexCmd ¶

func NewIndexCmd(deps *Deps) *cobra.Command

NewIndexCmd returns the `index` cobra command.

Usage examples:

tap index
tap index changes.md
tap index -k ecw nodes.tsv

func NewInfoCmd ¶

func NewInfoCmd(deps *Deps) *cobra.Command

NewInfoCmd returns the `info` cobra command.

Usage examples:

tap info
tap info --keg myalias

func NewInitCmd ¶

func NewInitCmd(deps *Deps) *cobra.Command

NewInitCmd returns the `tap repo init` cobra command.

Usage examples:

tap repo init NAME
tap repo init . --project
tap repo init blog --registry --repo knut --namespace me
tap repo init blog --project --path ./kegs/blog --title "Blog" --creator "me"

func NewListCmd ¶

func NewListCmd(deps *Deps) *cobra.Command

func NewMetaCmd ¶

func NewMetaCmd(deps *Deps) *cobra.Command

func NewMoveCmd ¶

func NewMoveCmd(deps *Deps) *cobra.Command

func NewPwdCmd ¶

func NewPwdCmd(deps *Deps) *cobra.Command

func NewReindexCmd ¶ added in v0.2.0

func NewReindexCmd(deps *Deps) *cobra.Command

NewReindexCmd returns the `reindex` cobra command.

func NewRemoveCmd ¶

func NewRemoveCmd(deps *Deps) *cobra.Command

func NewRepoCmd ¶

func NewRepoCmd(deps *Deps) *cobra.Command

func NewRepoConfigCmd ¶

func NewRepoConfigCmd(deps *Deps) *cobra.Command

NewRepoConfigCmd returns the `repo config` cobra command.

Usage examples:

tap repo config
tap repo config --project
tap repo config --user
tap repo config --template
tap repo config --template --project
tap repo config edit
tap repo config edit --project

func NewRepoConfigEditCmd ¶

func NewRepoConfigEditCmd(deps *Deps) *cobra.Command

NewRepoConfigEditCmd returns the `repo config edit` cobra subcommand.

Usage examples:

tap repo config edit
tap repo config edit --project

func NewRepoKegListCmd ¶

func NewRepoKegListCmd(deps *Deps) *cobra.Command

func NewRootCmd ¶

func NewRootCmd(deps *Deps) *cobra.Command

func NewStatsCmd ¶

func NewStatsCmd(deps *Deps) *cobra.Command

NewStatsCmd returns the `stats` cobra command.

func NewTagsCmd ¶

func NewTagsCmd(deps *Deps) *cobra.Command

func Run ¶

func Run(ctx context.Context, rt *toolkit.Runtime, args []string) (int, error)

func RunWithProfile ¶

func RunWithProfile(ctx context.Context, rt *toolkit.Runtime, args []string, profile Profile) (int, error)

Types ¶

type Deps ¶

type Deps struct {
	Root     string
	Shutdown func()
	Runtime  *toolkit.Runtime
	Profile  Profile

	ConfigPath string
	LogFile    string
	LogLevel   string
	LogJSON    bool

	Tap *tapper.Tap
	Err error
}

type Profile ¶

type Profile struct {
	// Use is the root command name shown in help.
	Use string

	// ForceProjectResolution makes node operations resolve only against
	// project-local kegs.
	ForceProjectResolution bool

	// AllowKegAliasFlags enables alias-based selection flags such as --keg.
	AllowKegAliasFlags bool

	// IncludeConfigCommand enables the config command tree.
	IncludeConfigCommand bool

	// IncludeRepoCommand enables the repo command tree.
	IncludeRepoCommand bool
}

Profile configures CLI behavior for a specific binary.

func KegV2Profile ¶

func KegV2Profile() Profile

func TapProfile ¶

func TapProfile() Profile

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

Documentation ¶

Index ¶

Constants ¶

Variables ¶

Functions ¶

func NewBacklinksCmd ¶

func NewCatCmd ¶

func NewConfigCmd ¶

func NewCreateCmd ¶

func NewEditCmd ¶

func NewFileCmd ¶ added in v0.2.0

func NewGrepCmd ¶

func NewImageCmd ¶ added in v0.2.0

func NewIndexCmd ¶

func NewInfoCmd ¶

func NewInitCmd ¶

func NewListCmd ¶

func NewMetaCmd ¶

func NewMoveCmd ¶

func NewPwdCmd ¶

func NewReindexCmd ¶ added in v0.2.0

func NewRemoveCmd ¶

func NewRepoCmd ¶

func NewRepoConfigCmd ¶

func NewRepoConfigEditCmd ¶

func NewRepoKegListCmd ¶

func NewRootCmd ¶

func NewStatsCmd ¶

func NewTagsCmd ¶

func Run ¶

func RunWithProfile ¶

Types ¶

type Deps ¶

type Profile ¶

func KegV2Profile ¶

func TapProfile ¶

Source Files ¶