commands

package
v0.13.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 26, 2024 License: Apache-2.0 Imports: 32 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	// GitSHA is set at build time
	GitSHA string

	// Version is set at build time
	Version string
)
View Source
var DocsGenCmd = &cobra.Command{
	Use:   "docs-gen",
	Short: "Generate documentation for rollkit CLI",
	RunE: func(cmd *cobra.Command, args []string) error {

		err := os.RemoveAll(docsDirectory)
		if err != nil {
			return err
		}

		err = os.MkdirAll(docsDirectory, os.ModePerm)
		if err != nil {
			return err
		}
		err = doc.GenMarkdownTree(RootCmd, docsDirectory)
		if err != nil {
			return err
		}
		return docCleanUp()
	},
}

DocsGenCmd is the command to generate documentation for rollkit CLI

View Source
var RootCmd = &cobra.Command{
	Use:   "rollkit",
	Short: "A modular framework for rollups, with an ABCI-compatible client interface.",
	Long: `
Rollkit is a modular framework for rollups, with an ABCI-compatible client interface.
The rollkit-cli uses the environment variable "RKHOME" to point to a file path where the node keys, config, and data will be stored. 
If a path is not specified for RKHOME, the rollkit command will create a folder "~/.rollkit" where it will store said data.
`,
}

RootCmd is the root command for Rollkit

View Source
var VersionCmd = &cobra.Command{
	Use:   "version",
	Short: "Show version info",
	RunE: func(cmd *cobra.Command, args []string) error {
		if GitSHA == "" {
			return errors.New("git SHA not set")
		}
		if Version == "" {
			return errors.New("version not set")
		}
		w := tabwriter.NewWriter(os.Stdout, 2, 0, 2, ' ', 0)
		fmt.Fprintf(w, "\nrollkit version:\t%v\n", Version)
		fmt.Fprintf(w, "rollkit git sha:\t%v\n", GitSHA)
		fmt.Fprintln(w, "")
		return w.Flush()
	},
}

VersionCmd is the command to show version info for rollkit CLI

Functions

func NewRunNodeCmd

func NewRunNodeCmd() *cobra.Command

NewRunNodeCmd returns the command that allows the CLI to start a node.

Types

This section is empty.

Jump to

Keyboard shortcuts

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