clockworklabs / clockworklabs/SpacetimeDB
spacetime-update --version spacetime-cli --version and spacetime-standalone --version should all match
@jdetter is already working on this.
Since Feb 21, 2025.
- Dominant language
- Rust
- Stars
- 25.2k
- Forks
- 1.1k
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 46
Description
Right now we have these 3 binaries which give completely different outputs when you pass --version:
Boppy@JASKIER MINGW64 ~/clockwork/tmp
$ ./spacetimedb-standalone.exe --version
spacetimedb spacetimedb tool version 1.0.0-rc4; spacetimedb-lib version 1.0.0-rc4;
Boppy@JASKIER MINGW64 ~/clockwork/tmp
$ ./spacetimedb-cli.exe --version
spacetime Path: C:\Users\Boppy\clockwork\tmp\spacetimedb-cli.exe
Commit: f7c06cb4e85df20313fca6a0167b66170eb038d4
spacetimedb tool version 1.0.0-rc4; spacetimedb-lib version 1.0.0-rc4;
Boppy@JASKIER MINGW64 ~/clockwork/tmp
$ ./spacetimedb-update.exe --version
error: unexpected argument '--version' found
Usage: spacetime [OPTIONS] <COMMAND>
For more information, try '--help'.
These should be consistent so that its easier to identify what version a binary came from. Please change spacetime-update and spacetime-standalone to use this output (the CLI crate is already good):
Boppy@JASKIER MINGW64 ~/clockwork/tmp
$ ./spacetimedb-cli.exe --version
spacetime Path: C:\Users\Boppy\clockwork\tmp\spacetimedb-cli.exe
Commit: f7c06cb4e85df20313fca6a0167b66170eb038d4
spacetimedb tool version 1.0.0-rc4; spacetimedb-lib version 1.0.0-rc4;
Also the help section does not mention that --version is valid at all:
Boppy@JASKIER MINGW64 ~/clockwork/tmp
$ ./spacetimedb-update.exe --help
Manage installed spacetime versions
Usage: spacetime [OPTIONS] <COMMAND>
Commands:
version
self-install
help Print this message or the help of the given subcommand(s)
Options:
--root-dir <ROOT_DIR>
-h, --help Print help
Boppy@JASKIER MINGW64 ~/clockwork/tmp
$ ./spacetimedb-update version
Usage: spacetime version <COMMAND>
Commands:
list List installed SpacetimeDB versions
use Set the global default SpacetimeDB version
upgrade Upgrade and switch to the latest available version of SpacetimeDB
install Install a specific SpacetimeDB version
uninstall Uninstall an installed SpacetimeDB version
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
These list the "version" subcommand which is completely different than --version. This is extremely confusing UX.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.