cmd

Documentation

Overview

Copyright The KCL Authors. All rights reserved.

Copyright The KCL Authors. All rights reserved.

#### Language & Tooling Commands

``` kcl

	run           compile kcl package from a url or filepath
	build         build the kcl package (Not yet implemented)
	check         check the current package, but don't build target files (Not yet implemented)
	doc           documentation tool
	fmt           format tool
	lint          lint tool
	vet           vet tool
	test          unit/integration/benchmark test tool (Not yet implemented)
 	deps          dependency analysis, providing dependency diagrams for KCL modules and packages (Not yet implemented)
 	server        run a KCL server to provider REST APIs for other applications
	clean         remove object files and cached files

```

#### Package & Registry Related Commands (mod and registry workspace)

``` kcl

mod init         initialize new module in current directory
mod search       search a command from regisry
mod add          add new dependency
mod remove       remove dependency
mod update       update dependency
mod pkg          package a kcl package into tar
mod metadata     output the resolved dependencies of a package
mod push         push kcl package to OCI registry.
mod pull         pull kcl package from OCI registry.
registry login   login to a registry
registry logout  logout from a registry

```

#### Integration Commands

``` kcl

import     migration other data and schema to kcl e.g., openapi, jsonschema, json, yaml
export     convert kcl schema to other schema e.g., openapi

```

#### Plugin Commands (plugin workspace)

``` kcl

plugin install     install one or more kcl command plugins
plugin list        list installed command plugins
plugin uninstall   uninstall one or more command plugins
plugin update      update one or more command plugins

```

#### Version and Help Commands

``` kcl

help, h   Shows a list of commands or help for one command
version   Shows the command version

``` #### Alias

``` alias kcl="kcl run" alias kpm="kcl mod" ```

Index

• func ModAdd(cli *client.KpmClient, args []string) error
• func ModPush(cli *client.KpmClient, args []string) error
• func New() *cobra.Command
• func NewCleanCmd() *cobra.Command
• func NewDocCmd() *cobra.Command
• func NewDocGenerateCmd() *cobra.Command
• func NewFmtCmd() *cobra.Command
• func NewImportCmd() *cobra.Command
• func NewLintCmd() *cobra.Command
• func NewModAddCmd(cli *client.KpmClient) *cobra.Command
• func NewModCmd() *cobra.Command
• func NewModInitCmd(cli *client.KpmClient) *cobra.Command
• func NewModMetadataCmd(cli *client.KpmClient) *cobra.Command
• func NewModPkgCmd(cli *client.KpmClient) *cobra.Command
• func NewModPullCmd(cli *client.KpmClient) *cobra.Command
• func NewModPushCmd(cli *client.KpmClient) *cobra.Command
• func NewRegistryCmd() *cobra.Command
• func NewRegistryLoginCmd(cli *client.KpmClient) *cobra.Command
• func NewRegistryLogoutCmd(cli *client.KpmClient) *cobra.Command
• func NewRunCmd() *cobra.Command
• func NewServerCmd() *cobra.Command
• func NewVersionCmd() *cobra.Command
• func NewVetCmd() *cobra.Command

Functions

func ModAdd

func ModAdd(cli *client.KpmClient, args []string) error

func ModPush

func ModPush(cli *client.KpmClient, args []string) error

func New

func New() *cobra.Command

New creates a new cobra client

func NewCleanCmd

func NewCleanCmd() *cobra.Command

NewCleanCmd returns the clean command.

func NewDocCmd

func NewDocCmd() *cobra.Command

NewDocCmd returns the doc command.

func NewDocGenerateCmd

func NewDocGenerateCmd() *cobra.Command

NewDocGenerateCmd returns the doc generate command.

func NewFmtCmd

func NewFmtCmd() *cobra.Command

NewFmtCmd returns the fmt command.

func NewImportCmd

func NewImportCmd() *cobra.Command

NewImportCmd returns the import command.

func NewLintCmd

func NewLintCmd() *cobra.Command

NewLintCmd returns the lint command.

func NewModAddCmd

func NewModAddCmd(cli *client.KpmClient) *cobra.Command

NewModAddCmd returns the mod add command.

func NewModCmd

func NewModCmd() *cobra.Command

NewModCmd returns the mod command.

func NewModInitCmd

func NewModInitCmd(cli *client.KpmClient) *cobra.Command

NewModInitCmd returns the mod init command.

func NewModMetadataCmd

func NewModMetadataCmd(cli *client.KpmClient) *cobra.Command

NewModMetadataCmd returns the mod metadata command.

func NewModPkgCmd

func NewModPkgCmd(cli *client.KpmClient) *cobra.Command

NewModPkgCmd returns the mod pkg command.

func NewModPullCmd

func NewModPullCmd(cli *client.KpmClient) *cobra.Command

NewModPullCmd returns the mod pull command.

func NewModPushCmd

func NewModPushCmd(cli *client.KpmClient) *cobra.Command

NewModPushCmd returns the mod push command.

func NewRegistryCmd

func NewRegistryCmd() *cobra.Command

NewModCmd returns the mod command.

func NewRegistryLoginCmd

func NewRegistryLoginCmd(cli *client.KpmClient) *cobra.Command

NewRegistryLoginCmd returns the registry login command.

func NewRegistryLogoutCmd

func NewRegistryLogoutCmd(cli *client.KpmClient) *cobra.Command

NewRegistryLogoutCmd returns the registry logout command.

func NewRunCmd

func NewRunCmd() *cobra.Command

NewRunCmd returns the run command.

func NewServerCmd

func NewServerCmd() *cobra.Command

NewServerCmd returns the server command.

func NewVersionCmd

func NewVersionCmd() *cobra.Command

NewVersionCmd returns the version command.

func NewVetCmd

func NewVetCmd() *cobra.Command

NewVetCmd returns the vet command.