Skip to content

Commit

Permalink
hof/mod: update command help, also bump hof version in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
verdverm committed Mar 10, 2023
1 parent dec3c72 commit 3f3eef4
Show file tree
Hide file tree
Showing 6 changed files with 80 additions and 52 deletions.
31 changes: 19 additions & 12 deletions .hof/shadow/cli/cmd/hof/cmd/mod.go
Original file line number Diff line number Diff line change
Expand Up @@ -64,28 +64,35 @@ Both token and sshkey base methods are supported, with preferences:
### Usage
# Initialize this folder as a module (github.com/org/repo)
hof mod init <module-path>
there are two main commands you will use, init & tidy
# Add or update a dependency
hof mod get github.com/hofstadter-io/hof@latest
# Initialize the current folder as a module
hof mod init <module-path> (like github.com/org/repo)
# Refresh dependencies, discovering any new imports
hof mod tidy
# Add a dependency
hof mod get github.com/hofstadter-io/hof@v0.6.8
hof mod get github.com/hofstadter-io/hof@v0.6.8-beta.6
hof mod get github.com/hofstadter-io/hof@latest // latest semver
hof mod get github.com/hofstadter-io/hof@next // next prerelease
hof mod get github.com/hofstadter-io/hof@main // latest commit on branch
# Tidy module files
hof mod tidy
# Update dependencies
hof mod get github.com/hofstadter-io/hof@latest
hof mod get all@latest
# symlink dependencies from local cache
# Symlink dependencies from local cache
hof mod link
# copy dependency code from local cache
# Copy dependency code from local cache
hof mod vendor
# update dependencies
hof mod get github.com/hofstadter-io/hof@latest
hof mod get all@latest
# Verify dependency code against cue.mod/sums.cue
hof mod verify
# print help
# This helpful output
hof mod help
`
Expand Down
31 changes: 19 additions & 12 deletions cmd/hof/cmd/mod.go
Original file line number Diff line number Diff line change
Expand Up @@ -64,28 +64,35 @@ Both token and sshkey base methods are supported, with preferences:
### Usage
# Initialize this folder as a module (github.com/org/repo)
hof mod init <module-path>
there are two main commands you will use, init & tidy
# Add or update a dependency
hof mod get github.com/hofstadter-io/hof@latest
# Initialize the current folder as a module
hof mod init <module-path> (like github.com/org/repo)
# Refresh dependencies, discovering any new imports
hof mod tidy
# Add a dependency
hof mod get github.com/hofstadter-io/hof@v0.6.8
hof mod get github.com/hofstadter-io/hof@v0.6.8-beta.6
hof mod get github.com/hofstadter-io/hof@latest // latest semver
hof mod get github.com/hofstadter-io/hof@next // next prerelease
hof mod get github.com/hofstadter-io/hof@main // latest commit on branch
# Tidy module files
hof mod tidy
# Update dependencies
hof mod get github.com/hofstadter-io/hof@latest
hof mod get all@latest
# symlink dependencies from local cache
# Symlink dependencies from local cache
hof mod link
# copy dependency code from local cache
# Copy dependency code from local cache
hof mod vendor
# update dependencies
hof mod get github.com/hofstadter-io/hof@latest
hof mod get all@latest
# Verify dependency code against cue.mod/sums.cue
hof mod verify
# print help
# This helpful output
hof mod help
`
Expand Down
31 changes: 19 additions & 12 deletions design/cmds/mod.cue
Original file line number Diff line number Diff line change
Expand Up @@ -183,29 +183,36 @@ import (
### Usage
there are two main commands you will use, init & tidy
# Initialize this folder as a module (github.com/org/repo)
hof mod init <module-path>
# Initialize the current folder as a module
hof mod init <module-path> (like github.com/org/repo)
# Refresh dependencies, discovering any new imports
hof mod tidy
# Add or update a dependency
hof mod get github.com/hofstadter-io/hof@latest
# Add a dependency
hof mod get github.com/hofstadter-io/hof@v0.6.8
hof mod get github.com/hofstadter-io/hof@v0.6.8-beta.6
hof mod get github.com/hofstadter-io/hof@latest // latest semver
hof mod get github.com/hofstadter-io/hof@next // next prerelease
hof mod get github.com/hofstadter-io/hof@main // latest commit on branch
# Tidy module files
hof mod tidy
# Update dependencies
hof mod get github.com/hofstadter-io/hof@latest
hof mod get all@latest
# symlink dependencies from local cache
# Symlink dependencies from local cache
hof mod link
# copy dependency code from local cache
# Copy dependency code from local cache
hof mod vendor
# update dependencies
hof mod get github.com/hofstadter-io/hof@latest
hof mod get all@latest
# Verify dependency code against cue.mod/sums.cue
hof mod verify
# print help
# This helpful output
hof mod help
Expand Down
31 changes: 19 additions & 12 deletions docs/code/cmd-help/mod
Original file line number Diff line number Diff line change
Expand Up @@ -54,28 +54,35 @@ Both token and sshkey base methods are supported, with preferences:

### Usage

# Initialize this folder as a module (github.com/org/repo)
hof mod init <module-path>
there are two main commands you will use, init & tidy

# Add or update a dependency
hof mod get github.com/hofstadter-io/hof@latest
# Initialize the current folder as a module
hof mod init <module-path> (like github.com/org/repo)

# Refresh dependencies, discovering any new imports
hof mod tidy

# Add a dependency
hof mod get github.com/hofstadter-io/hof@v0.6.8
hof mod get github.com/hofstadter-io/hof@v0.6.8-beta.6
hof mod get github.com/hofstadter-io/hof@latest // latest semver
hof mod get github.com/hofstadter-io/hof@next // next prerelease
hof mod get github.com/hofstadter-io/hof@main // latest commit on branch

# Tidy module files
hof mod tidy
# Update dependencies
hof mod get github.com/hofstadter-io/hof@latest
hof mod get all@latest

# symlink dependencies from local cache
# Symlink dependencies from local cache
hof mod link

# copy dependency code from local cache
# Copy dependency code from local cache
hof mod vendor

# update dependencies
hof mod get github.com/hofstadter-io/hof@latest
hof mod get all@latest
# Verify dependency code against cue.mod/sums.cue
hof mod verify

# print help
# This helpful output
hof mod help

Usage:
Expand Down
2 changes: 1 addition & 1 deletion docs/config.cue
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ params: {
github_repo: "https://github.com/hofstadter-io/hof-docs"
time_format_default: "January 2, 2006"
keywords: "hof hofstadter documentation docs"
hofver: "v0.6.8-beta.7"
hofver: "v0.6.8-beta.11"
cuever: "v0.5.0-beta.5"
cuedocBase: "https://pkg.go.dev/cuelang.org/go@\(cuever)"

Expand Down
6 changes: 3 additions & 3 deletions docs/config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,17 @@ params:
github_repo: https://github.com/hofstadter-io/hof-docs
time_format_default: January 2, 2006
keywords: hof hofstadter documentation docs
hofver: v0.6.8-beta.7
hofver: v0.6.8-beta.11
cuever: v0.5.0-beta.5
cuedocBase: https://pkg.go.dev/cuelang.org/go@v0.5.0-beta.5
beta: |-
The `hof gen` adhoc feature (`-T`) is only available in the next beta.
```
go install github.com/hofstadter-io/hof/cmd/hof@v0.6.8-beta.7
go install github.com/hofstadter-io/hof/cmd/hof@v0.6.8-beta.11
```
[Download binaries on GitHub](https://github.com/hofstadter-io/hof/releases/tag/v0.6.8-beta.7)
[Download binaries on GitHub](https://github.com/hofstadter-io/hof/releases/tag/v0.6.8-beta.11)
markup:
goldmark:
renderer:
Expand Down

0 comments on commit 3f3eef4

Please sign in to comment.