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 NewGrepCmd(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 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
Constants ¶
This section is empty.
Variables ¶
var (
Version string = "dev"
)
Functions ¶
func NewBacklinksCmd ¶
func NewCatCmd ¶
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 ¶
NewConfigCmd returns the `config` cobra command.
Usage examples:
tap config tap config --keg myalias tap config --edit tap config --edit --keg myalias
func NewCreateCmd ¶
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 ¶
NewEditCmd returns the `edit` cobra command.
func NewGrepCmd ¶
func NewIndexCmd ¶
NewIndexCmd returns the `index` cobra command.
Usage examples:
Tap index Tap index --alias myalias
func NewInfoCmd ¶
NewInfoCmd returns the `info` cobra command.
Usage examples:
tap info tap info --keg myalias
func NewInitCmd ¶
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 ./docs --title "Blog" --creator "me"
func NewListCmd ¶
func NewMetaCmd ¶
func NewMoveCmd ¶
func NewRemoveCmd ¶
func NewRepoCmd ¶
func NewRepoConfigCmd ¶
NewRepoConfigCmd returns the `repo config` cobra command.
Usage examples:
tap repo config tap repo config --project tap repo config --user tap repo config edit tap repo config edit --project
func NewRepoConfigEditCmd ¶
NewRepoConfigEditCmd returns the `repo config edit` cobra subcommand.
Usage examples:
tap repo config edit tap repo config edit --project
func NewRepoKegListCmd ¶
func NewRootCmd ¶
func NewStatsCmd ¶
NewStatsCmd returns the `stats` cobra command.
func NewTagsCmd ¶
Types ¶
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
Source Files
¶
- backlinks_cmd.go
- cat_cmd.go
- cli.go
- config_cmd.go
- config_edit_cmd.go
- constants.go
- create_cmd.go
- dir_cmd.go
- edit_cmd.go
- error_render.go
- grep_cmd.go
- index_cmd.go
- info_cmd.go
- init_cmd.go
- keg_target_flags.go
- list_cmd.go
- meta_cmd.go
- mv_cmd.go
- profile.go
- repo_cmd.go
- repo_config_cmd.go
- rm_cmd.go
- root_cmd.go
- stats_cmd.go
- tags_cmd.go