kimono

README

kimono

Go monorepo utility: toggle go.work, tidy all modules, bump/list/delete per-module semver tags, and list dependencies/dependents.

go install github.com/chaitanyabsprip/kimono/cmd/kimono@latest
kimono help

Originally part of bonzai.

Documentation

Index

• Constants
• Variables
• func ListDependencies() ([]string, error)
• func ListDependents() ([]string, error)
• func TagBump(part VerPart, mustPush bool) error
• func TagDelete(tag string, remote bool) error
• func TagList(shorten bool) []string
• func TidyAll(root string) error
• func TidyDependencies() error
• func TidyDependents() error
• func WorkGenerate() error
• func WorkInit(args ...string) error
• func WorkToggleModule(from, to string) error
• func WorkToggleRecursive(root, from, to string) error
• type VerPart

Constants

const (
	WorkScopeEnv   = `KIMONO_WORK_SCOPE`
	WorkScopeVar   = `work-scope`
	TagVerPartEnv  = `KIMONO_VERSION_PART`
	TagVerPartVar  = `tag-ver-part`
	TagShortenEnv  = `KIMONO_TAG_SHORTEN`
	TagShortenVar  = `tag-shorten`
	TagRmRemoteEnv = `KIMONO_TAG_RM_REMOTE`
	TagRmRemoteVar = `tag-rm-remote`
	TagPushEnv     = `KIMONO_PUSH_TAG`
	TagPushVar     = `tag-push`
	TidyScopeEnv   = `KIMONO_TIDY_SCOPE`
	TidyScopeVar   = `tidy-scope`
)

Variables

var Cmd = &bonzai.Cmd{
	Name:  `kimono`,
	Alias: `kmono|km`,
	Vers:  `v0.7.0`,
	Short: `manage golang monorepos`,
	Long: `
The kimono tool helps manage Go monorepos. It simplifies common monorepo
operations and workflow management.

# Features:
- Toggle go.work files on/off for local development
- Perform coordinated version tagging
- Keep go.mod files tidy across modules
- View dependency graphs and module information
- Track dependent modules and their relationships

# Commands:
- work:     Toggle go.work files for local development
- tidy:     run 'go get -u' and 'go mod tidy' across modules
- tag:      List and coordinate version tagging across modules
- deps:     List and manage module dependencies
- depsonme: List and manage module dependencies
- vars:     View and set configuration variables

Use 'kimono help <command> <subcommand>...' for detailed information
about each command.
`,
	Comp: comp.Cmds,
	Cmds: []*bonzai.Cmd{
		workCmd,
		tidyCmd,
		tagCmd,
		dependenciesCmd,
		dependentsCmd,
		vars.Cmd,
		help.Cmd,
	},
	Def: help.Cmd,
}

Functions

func ListDependencies

func ListDependencies() ([]string, error)

ListDependencies returns a list of all Go modules that the current module depends on.

func ListDependents

func ListDependents() ([]string, error)

ListDependents returns a list of all Go modules that depend on the current module.

func TagBump

func TagBump(part VerPart, mustPush bool) error

func TagDelete

func TagDelete(tag string, remote bool) error

TagDelete deletes the given tag from local git repository.

func TagList

func TagList(shorten bool) []string

TagList returns the list of tags for the current module.

func TidyAll

func TidyAll(root string) error

Tidy runs `go get -u` and `go mod tidy` on all supported Go modules in the current git repository.

func TidyDependencies

func TidyDependencies() error

func TidyDependents

func TidyDependents() error

func WorkGenerate

func WorkGenerate() error

func WorkInit

func WorkInit(args ...string) error

func WorkToggleModule

func WorkToggleModule(from, to string) error

func WorkToggleRecursive

func WorkToggleRecursive(root, from, to string) error

Types

type VerPart

type VerPart int

const (
	Major VerPart = 0
	Minor VerPart = 1
	Patch VerPart = 2
)