Skip to content

Commit

Permalink
Improved docs
Browse files Browse the repository at this point in the history
  • Loading branch information
NiclasHaderer committed Mar 9, 2024
1 parent 0f0804e commit 37ce375
Show file tree
Hide file tree
Showing 4 changed files with 40 additions and 5 deletions.
37 changes: 36 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,36 @@
+ cobra-cli add update-self
# DuckDB Version Manager

### Installation

TODO

### Usage
```bash
duck-vm --help

A version manager for DuckDB

Usage:
duck-vm [command]

Available Commands:
completion Generate the autocompletion script for the specified shell
default Set a version of DuckDB as default one to use.
help Help about any command
install Install a specific version of DuckDB
list List available DuckDB versions. Use 'local' to list local versions and 'remote' to list remote versions.
run Execute a specific version of DuckDB
uninstall Uninstall a version of DuckDB
update-self Updates duck-vm to the latest version

Flags:
-h, --help help for duck-vm

Use "duck-vm [command] --help" for more information about a command.
```

### Building from source

1. Install golang (https://go.dev/doc/install) if you haven't already
2. Run the *compile.sh* script to build binaries for all platforms. The binaries will be placed in the *bin* directory
after the compilation is done.
2 changes: 1 addition & 1 deletion cmd/default.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (
// defaultCmd represents the default command
var defaultCmd = &cobra.Command{
Use: "default [version]",
Short: "Set an already installed version of DuckDB as the default one",
Short: "Set a version of DuckDB as default one to use.",
Args: cobra.ExactArgs(1),
Run: func(cmd *cobra.Command, args []string) {
path, err := utils.GetInstalledVersionPathOrInstall(args[0])
Expand Down
2 changes: 1 addition & 1 deletion cmd/list.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (
// listCmd represents the list command
var listCmd = &cobra.Command{
Use: "list",
Short: "List available DuckDB versions",
Short: "List available DuckDB versions. Use 'local' to list local versions and 'remote' to list remote versions.",
}

func init() {
Expand Down
4 changes: 2 additions & 2 deletions cmd/updateSelf.go → cmd/update_self.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ import (
)

var updateSelfCmd = &cobra.Command{
Use: "updateSelf",
Short: "Updates the duck-vm binary to the latest version",
Use: "update-self",
Short: "Updates duck-vm to the latest version",
Run: func(cmd *cobra.Command, args []string) {
log.Fatalf("This feature is not implemented yet")
},
Expand Down

0 comments on commit 37ce375

Please sign in to comment.