Skip to content

Commit 36c93b0

Browse files
dipankardas011dipankardas011
committed
refactor: rename cli project from ksctl to kli
This commit updates all references of the project name from "ksctl" to "kli" across the codebase, documentation, scripts, and configuration files. The module path, binary names, import paths, and user-facing messages have been updated accordingly. This change ensures consistency with the new project branding and prepares the repository for future releases under the "kli" name. Signed-off-by: Dipankar Das <65275144+dipankardas011@users.noreply.github.com>
1 parent 389b3c9 commit 36c93b0

28 files changed

Lines changed: 120 additions & 126 deletions

‎.goreleaser.yaml‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
version: 2
1010

11-
project_name: ksctl-kli
11+
project_name: kli
1212

1313
before:
1414
hooks:
@@ -17,18 +17,18 @@ before:
1717
builds:
1818
- env:
1919
- CGO_ENABLED=0
20-
binary: ksctl
20+
binary: kli
2121
goos:
2222
- linux
2323
- darwin
2424
goarch:
2525
- amd64
2626
- arm64
2727
ldflags:
28-
- -s -w -X "github.com/ksctl/cli/v2/pkg/config.BuildDate={{.Env.DATE}}"
29-
- -s -w -X "github.com/ksctl/cli/v2/pkg/config.Version={{.Env.VERSION}}"
30-
- -s -w -X "github.com/ksctl/cli/v2/pkg/config.KsctlCoreVer={{.Env.OCIVERSION}}"
31-
- -s -w -X "github.com/ksctl/cli/v2/pkg/telemetry.clientIdentity={{.Env.CLI_IDENTITY}}"
28+
- -s -w -X "github.com/ksctl/kli/v2/pkg/config.BuildDate={{.Env.DATE}}"
29+
- -s -w -X "github.com/ksctl/kli/v2/pkg/config.Version={{.Env.VERSION}}"
30+
- -s -w -X "github.com/ksctl/kli/v2/pkg/config.KsctlCoreVer={{.Env.OCIVERSION}}"
31+
- -s -w -X "github.com/ksctl/kli/v2/pkg/telemetry.clientIdentity={{.Env.CLI_IDENTITY}}"
3232

3333
signs:
3434
- cmd: cosign

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This CLI utilizes the core components from [Ksctl](https://github.com/ksctl/ksct
1616
Repo | Description
1717
-|-
1818
[Ksctl](https://github.com/ksctl/ksctl) | It provides the core components aka the internals of ksctl features
19-
[Ksctl CLI](https://github.com/ksctl/kli) | Builds on top of the core Ksctl repository to provide a CLI tool
19+
[kli](https://github.com/ksctl/kli) | Builds on top of the core Ksctl repository to provide a CLI tool
2020
[Ksctl Docs](https://github.com/ksctl/docs) | It's for documentation purpose and to host the ksctl website
2121

2222
## Getting Started guide

‎cmd/addons.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ import (
2020
"strconv"
2121
"strings"
2222

23-
"github.com/ksctl/cli/v2/pkg/cli"
24-
"github.com/ksctl/cli/v2/pkg/telemetry"
23+
"github.com/ksctl/kli/v2/pkg/cli"
24+
"github.com/ksctl/kli/v2/pkg/telemetry"
2525
"github.com/ksctl/ksctl/v2/pkg/handler/cluster/controller"
2626

2727
addonsHandler "github.com/ksctl/ksctl/v2/pkg/handler/addons"
@@ -33,7 +33,7 @@ func (k *KsctlCommand) Addons() *cobra.Command {
3333
cmd := &cobra.Command{
3434
Use: "addons",
3535
Example: `
36-
ksctl addons --help
36+
kli addons --help
3737
`,
3838
Short: "Use to work with addons",
3939
Long: "It is used to work with addons",
@@ -47,7 +47,7 @@ func (k *KsctlCommand) EnableAddon() *cobra.Command {
4747
cmd := &cobra.Command{
4848
Use: "enable",
4949
Example: `
50-
ksctl addons enable --help
50+
kli addons enable --help
5151
`,
5252
Short: "Use to enable an addon",
5353
Long: "It is used to enable an addon",
@@ -137,7 +137,7 @@ func (k *KsctlCommand) DisableAddon() *cobra.Command {
137137
cmd := &cobra.Command{
138138
Use: "disable",
139139
Example: `
140-
ksctl addons disable --help
140+
kli addons disable --help
141141
`,
142142
Short: "Use to disable an addon",
143143
Long: "It is used to disable an addon",

‎cmd/cli.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ import (
1818
"context"
1919
"os"
2020

21-
"github.com/ksctl/cli/v2/pkg/cli"
22-
"github.com/ksctl/cli/v2/pkg/config"
23-
cLogger "github.com/ksctl/cli/v2/pkg/logger"
24-
"github.com/ksctl/cli/v2/pkg/telemetry"
21+
"github.com/ksctl/kli/v2/pkg/cli"
22+
"github.com/ksctl/kli/v2/pkg/config"
23+
cLogger "github.com/ksctl/kli/v2/pkg/logger"
24+
"github.com/ksctl/kli/v2/pkg/telemetry"
2525
"github.com/ksctl/ksctl/v2/pkg/consts"
2626
"github.com/ksctl/ksctl/v2/pkg/logger"
2727
"github.com/ksctl/ksctl/v2/pkg/provider"

‎cmd/completion.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,25 @@ func (k *KsctlCommand) ShellCompletion() *cobra.Command {
1515
1616
Bash:
1717
18-
$ source <(ksctl completion bash)
18+
$ source <(kli completion bash)
1919
2020
# To load completions for each session, execute once:
2121
# Linux:
22-
$ ksctl completion bash > /etc/bash_completion.d/ksctl
22+
$ kli completion bash > /etc/bash_completion.d/kli
2323
# macOS:
24-
$ ksctl completion bash > /usr/local/etc/bash_completion.d/ksctl
24+
$ kli completion bash > /usr/local/etc/bash_completion.d/kli
2525
2626
Zsh:
2727
2828
$ echo "autoload -U compinit; compinit" >> ~/.zshrc
29-
$ ksctl completion zsh > "${fpath[1]}/_ksctl"
29+
$ kli completion zsh > "${fpath[1]}/_kli"
3030
3131
Fish:
3232
33-
$ ksctl completion fish | source
33+
$ kli completion fish | source
3434
3535
# To load completions for each session, execute once:
36-
$ ksctl completion fish > ~/.config/fish/completions/ksctl.fish
36+
$ kli completion fish > ~/.config/fish/completions/kli.fish
3737
`,
3838
Args: cobra.ExactArgs(1),
3939
RunE: func(cmd *cobra.Command, args []string) error {

‎cmd/configure.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ import (
2121
"strconv"
2222

2323
"github.com/fatih/color"
24-
"github.com/ksctl/cli/v2/pkg/cli"
25-
"github.com/ksctl/cli/v2/pkg/config"
24+
"github.com/ksctl/kli/v2/pkg/cli"
25+
"github.com/ksctl/kli/v2/pkg/config"
2626
"github.com/ksctl/ksctl/v2/pkg/consts"
2727
"github.com/ksctl/ksctl/v2/pkg/statefile"
2828
"github.com/ksctl/ksctl/v2/pkg/utilities"
@@ -34,8 +34,8 @@ func (k *KsctlCommand) Configure() *cobra.Command {
3434
cmd := &cobra.Command{
3535
Use: "configure",
3636

37-
Short: "Configure ksctl cli",
38-
Long: "It will display the current ksctl cli configuration",
37+
Short: "Configure kli",
38+
Long: "It will display the current kli configuration",
3939
Run: func(cmd *cobra.Command, args []string) {
4040
headers := []string{"Property", "Value"}
4141

‎cmd/connect.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ import (
2727

2828
"github.com/creack/pty"
2929
"github.com/fatih/color"
30-
"github.com/ksctl/cli/v2/pkg/cli"
31-
"github.com/ksctl/cli/v2/pkg/telemetry"
30+
"github.com/ksctl/kli/v2/pkg/cli"
31+
"github.com/ksctl/kli/v2/pkg/telemetry"
3232
"github.com/ksctl/ksctl/v2/pkg/handler/cluster/common"
3333
"github.com/ksctl/ksctl/v2/pkg/handler/cluster/controller"
3434
"github.com/ksctl/ksctl/v2/pkg/logger"
@@ -43,7 +43,7 @@ func (k *KsctlCommand) Connect() *cobra.Command {
4343
cmd := &cobra.Command{
4444
Use: "connect",
4545
Example: `
46-
ksctl connect --help
46+
kli connect --help
4747
`,
4848
Short: "Connect to existing cluster",
4949
Long: "It is used to connect to existing cluster",
@@ -189,7 +189,7 @@ func shellAccess(log logger.Logger) {
189189
}
190190
defer func() { _ = term.Restore(int(os.Stdin.Fd()), oldState) }()
191191

192-
fmt.Fprintln(ptmx, "echo Hi from Ksctl team! You are now in the shell session having cluster context.")
192+
fmt.Fprintln(ptmx, "echo Hi from kli team! You are now in the shell session having cluster context.")
193193
fmt.Fprintln(ptmx, "kubectl get nodes -owide && kubectl cluster-info")
194194

195195
go func() { _, _ = io.Copy(ptmx, os.Stdin) }()

‎cmd/create.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ import (
2424
"github.com/ksctl/ksctl/v2/pkg/consts"
2525
"github.com/ksctl/ksctl/v2/pkg/provider"
2626

27-
"github.com/ksctl/cli/v2/pkg/cli"
28-
"github.com/ksctl/cli/v2/pkg/telemetry"
27+
"github.com/ksctl/kli/v2/pkg/cli"
28+
"github.com/ksctl/kli/v2/pkg/telemetry"
2929
"github.com/ksctl/ksctl/v2/pkg/handler/cluster/controller"
3030

3131
controllerManaged "github.com/ksctl/ksctl/v2/pkg/handler/cluster/managed"
@@ -39,7 +39,7 @@ func (k *KsctlCommand) Create() *cobra.Command {
3939
cmd := &cobra.Command{
4040
Use: "create",
4141
Example: `
42-
ksctl create --help
42+
kli create --help
4343
`,
4444
Short: "Use to create a cluster",
4545
Long: "It is used to create cluster with the given name from user",

‎cmd/delete.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ import (
2020
"strconv"
2121
"strings"
2222

23-
"github.com/ksctl/cli/v2/pkg/cli"
24-
"github.com/ksctl/cli/v2/pkg/telemetry"
23+
"github.com/ksctl/kli/v2/pkg/cli"
24+
"github.com/ksctl/kli/v2/pkg/telemetry"
2525
"github.com/ksctl/ksctl/v2/pkg/consts"
2626
"github.com/ksctl/ksctl/v2/pkg/handler/cluster/controller"
2727
"github.com/ksctl/ksctl/v2/pkg/handler/cluster/managed"
@@ -35,7 +35,7 @@ func (k *KsctlCommand) Delete() *cobra.Command {
3535
cmd := &cobra.Command{
3636
Use: "delete",
3737
Example: `
38-
ksctl delete --help
38+
kli delete --help
3939
`,
4040
Short: "Use to delete a cluster",
4141
Long: "It is used to delete cluster with the given name from user",

‎cmd/get.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import (
2020
"strconv"
2121
"strings"
2222

23-
"github.com/ksctl/cli/v2/pkg/telemetry"
23+
"github.com/ksctl/kli/v2/pkg/telemetry"
2424
"github.com/ksctl/ksctl/v2/pkg/consts"
2525
"github.com/ksctl/ksctl/v2/pkg/logger"
2626
"github.com/ksctl/ksctl/v2/pkg/provider"
@@ -32,7 +32,7 @@ func (k *KsctlCommand) Get() *cobra.Command {
3232
cmd := &cobra.Command{
3333
Use: "get",
3434
Example: `
35-
ksctl get --help
35+
kli get --help
3636
`,
3737
Short: "Use to get the cluster",
3838
Long: "It is used to get the cluster created by the user",

0 commit comments

Comments
 (0)