Skip to content

Commit e388c2c

Browse files
authored
Merge pull request #141 from zong-zhe/fix-cli-doc
fix: fix cli doc with git ssh url
2 parents fb9366b + 5ba5186 commit e388c2c

File tree

3 files changed

+10
-1
lines changed

3 files changed

+10
-1
lines changed

cmd/kcl/commands/mod_add.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ const (
3939
# Add the sub module dependency named "helloworld" from the Git repo by the tag flag
4040
kcl mod add helloworld --git https://github.com/kcl-lang/modules --tag v0.1.0
4141
42+
# Add the sub module dependency named "helloworld" from the Git repo by the tag flag with ssh url
43+
kcl mod add helloworld --git ssh://github.com/kcl-lang/modules --tag v0.1.0
44+
4245
# Add the module dependency from the OCI registry named "" by the tag flag
4346
kcl mod add --oci https://ghcr.io/kcl-lang/helloworld --tag 0.1.0`
4447
)

cmd/kcl/commands/mod_pull.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ const (
2424
# Pull the module from the Git by flag
2525
kcl mod pull --git https://github.com/kcl-lang/konfig --tag v0.4.0
2626
27+
# Pull the module from the Git by flag with ssh url
28+
kcl mod pull --git ssh://github.com/kcl-lang/konfig --tag v0.4.0
29+
2730
# Pull the module from the OCI Registry by flag
2831
kcl mod pull --oci https://ghcr.io/kcl-lang/helloworld --tag 0.1.0`
2932
)

cmd/kcl/commands/run.go

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,10 @@ For example, 'kcl run path/to/kcl.k' will run the file named path/to/kcl.k
3737
kcl run --oci https://ghcr.io/kcl-lang/helloworld --tag 0.1.0
3838
3939
# Run remote module from Git with branch repo by flag
40-
kcl run --git https://github.com/kcl-lang/flask-demo-kcl-manifests --branch main`
40+
kcl run --git https://github.com/kcl-lang/flask-demo-kcl-manifests --branch main
41+
42+
# Run remote module from Git with branch repo by flag with ssh url
43+
kcl run --git ssh://github.com/kcl-lang/flask-demo-kcl-manifests --branch main`
4144
)
4245

4346
// NewRunCmd returns the run command.

0 commit comments

Comments
 (0)