Skip to content

Commit

Permalink
fix: fix cli doc with git ssh url
Browse files Browse the repository at this point in the history
Signed-off-by: zongz <zongzhe1024@163.com>
  • Loading branch information
zong-zhe committed Aug 29, 2024
1 parent fb9366b commit 5ba5186
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 1 deletion.
3 changes: 3 additions & 0 deletions cmd/kcl/commands/mod_add.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ const (
# Add the sub module dependency named "helloworld" from the Git repo by the tag flag
kcl mod add helloworld --git https://github.com/kcl-lang/modules --tag v0.1.0
# Add the sub module dependency named "helloworld" from the Git repo by the tag flag with ssh url
kcl mod add helloworld --git ssh://github.com/kcl-lang/modules --tag v0.1.0
# Add the module dependency from the OCI registry named "" by the tag flag
kcl mod add --oci https://ghcr.io/kcl-lang/helloworld --tag 0.1.0`
)
Expand Down
3 changes: 3 additions & 0 deletions cmd/kcl/commands/mod_pull.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ const (
# Pull the module from the Git by flag
kcl mod pull --git https://github.com/kcl-lang/konfig --tag v0.4.0
# Pull the module from the Git by flag with ssh url
kcl mod pull --git ssh://github.com/kcl-lang/konfig --tag v0.4.0
# Pull the module from the OCI Registry by flag
kcl mod pull --oci https://ghcr.io/kcl-lang/helloworld --tag 0.1.0`
)
Expand Down
5 changes: 4 additions & 1 deletion cmd/kcl/commands/run.go
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,10 @@ For example, 'kcl run path/to/kcl.k' will run the file named path/to/kcl.k
kcl run --oci https://ghcr.io/kcl-lang/helloworld --tag 0.1.0
# Run remote module from Git with branch repo by flag
kcl run --git https://github.com/kcl-lang/flask-demo-kcl-manifests --branch main`
kcl run --git https://github.com/kcl-lang/flask-demo-kcl-manifests --branch main
# Run remote module from Git with branch repo by flag with ssh url
kcl run --git ssh://github.com/kcl-lang/flask-demo-kcl-manifests --branch main`
)

// NewRunCmd returns the run command.
Expand Down

0 comments on commit 5ba5186

Please sign in to comment.