This project is NOT the srtool docker image that is actually used to build Substrate Wasm Runtime. This utility requires docker to be installed and running and will invoke the srtool image to help you build a Substrate runtime.
This project is a cli interface to docker to simplify using the srtool docker image. With this executable, you no longer need
to set and maintain a long and complex alias, as currently described in the srtool documentation.
If you previously defined srtool as an alias, you will first need to remove it first.
If you used srtool in the past, you previously used an srtool alias. You can check with:
type srtool
If you see some output mentioning "srtool is an alias for docker run…", you have an alias set and we need to remove it:
unalias srtool
This alias is likely set in your .bash_profile or .zshrc, make sure to remove this alias there as well.
cargo install --git https://github.com/chevdor/srtool-cli
help
srtool is cli allowing to control the srtool docker image
Usage: srtool [OPTIONS] <COMMAND>
Commands:
pull
Simply pull the srtool image and do not run anything else
build
Start a new srtool container to build your runtime
info
Provide information about the srtool container and your repo
version
Show the versions of the srtool container. Use --version if you want the version of this executable
help
Print this message or the help of the given subcommand(s)
Options:
-i, --image <IMAGE>
Choose an alternative image. Beware to choose an image that is compatible with the original srtool image. Using a random image, you take the risk to NOT produce exactly the same deterministic result as srtool
[default: docker.io/paritytech/srtool]
-j, --json
This option is DEPRECATED and has no effect
-n, --no-cache
Do not use the local cached tag value
-e, --engine <ENGINE>
By default, srtool-cli auto-detects whether you use Podman or Docker. You can force the engine if the detection does not meet your expectation. The default is auto and defaults to Podman.
NOTE: Using Podman currently forces using --no-cache
[default: auto]
-h, --help
Print help (see a summary with '-h')
-V, --version
Print version
version
Show the versions of the srtool container. Use --version if you want the version of this executable
Usage: srtool version [OPTIONS]
Options:
-i, --image <IMAGE>
Choose an alternative image. Beware to choose an image that is compatible with the original srtool image. Using a random image, you take the risk to NOT produce exactly the same deterministic result as srtool
[default: docker.io/paritytech/srtool]
-e, --engine <ENGINE>
By default, srtool-cli auto-detects whether you use Podman or Docker. You can force the engine if the detection does not meet your expectation. The default is auto and defaults to Podman.
NOTE: Using Podman currently forces using --no-cache
[default: auto]
-h, --help
Print help (see a summary with '-h')
-V, --version
Print version
info
Provide information about the srtool container and your repo
Usage: srtool info [OPTIONS] --package <PACKAGE> [PATH]
Arguments:
[PATH]
By default, srtool will work in the current folder. If your project is located in another location, you can pass it here
[default: .]
Options:
-i, --image <IMAGE>
Choose an alternative image. Beware to choose an image that is compatible with the original srtool image. Using a random image, you take the risk to NOT produce exactly the same deterministic result as srtool
[default: docker.io/paritytech/srtool]
-p, --package <PACKAGE>
Provide the runtime such as kusama-runtime, polkadot-runtime, etc...
[env: PACKAGE=]
-r, --runtime-dir <RUNTIME_DIR>
If your runtime is not in the standard location runtime/<chain_name> you can pass this args to help srtool find it
[env: RUNTIME_DIR=]
-e, --engine <ENGINE>
By default, srtool-cli auto-detects whether you use Podman or Docker. You can force the engine if the detection does not meet your expectation. The default is auto and defaults to Podman.
NOTE: Using Podman currently forces using --no-cache
[default: auto]
-h, --help
Print help (see a summary with '-h')
-V, --version
Print version
pull
Simply pull the srtool image and do not run anything else
Usage: srtool pull [OPTIONS]
Options:
-i, --image <IMAGE>
Choose an alternative image. Beware to choose an image that is compatible with the original srtool image. Using a random image, you take the risk to NOT produce exactly the same deterministic result as srtool
[default: docker.io/paritytech/srtool]
-e, --engine <ENGINE>
By default, srtool-cli auto-detects whether you use Podman or Docker. You can force the engine if the detection does not meet your expectation. The default is auto and defaults to Podman.
NOTE: Using Podman currently forces using --no-cache
[default: auto]
-h, --help
Print help (see a summary with '-h')
-V, --version
Print version
build
Start a new srtool container to build your runtime
Usage: srtool build [OPTIONS] --package <PACKAGE> [PATH]
Arguments:
[PATH]
By default, srtool will work in the current folder. If your project is located in another location, you can pass it here
[default: .]
Options:
-i, --image <IMAGE>
Choose an alternative image. Beware to choose an image that is compatible with the original srtool image. Using a random image, you take the risk to NOT produce exactly the same deterministic result as srtool
[default: docker.io/paritytech/srtool]
-p, --package <PACKAGE>
Provide the runtime such as kusama-runtime, polkadot-runtime, etc...
[env: PACKAGE=]
-j, --json
Enable json output, same than the global --json option
-a, --app
Enable the "app" mode which is a mix of json output and outputting progress during the build. This flag is recommended for CI. the json output will be provided as a single line at the end in compact mode
-e, --engine <ENGINE>
By default, srtool-cli auto-detects whether you use Podman or Docker. You can force the engine if the detection does not meet your expectation. The default is auto and defaults to Podman.
NOTE: Using Podman currently forces using --no-cache
[default: auto]
-r, --runtime-dir <RUNTIME_DIR>
If your runtime is not in the standard location runtime/<chain_name> you can pass this args to help srtool find it
[env: RUNTIME_DIR=]
--build-opts <BUILD_OPTS>
You may pass options to cargo directly here. WARNING, if you pass this value, the automatic build options for Kusama and Polkadot will not be passed and you need to take care of them manually. In general, you should never use this option unless you HAVE to
[env: BUILD_OPTS=]
--default-features <DEFAULT_FEATURES>
Passing this is less involved than passing BUILD_OPTS. It allows changing the list of default features while keeping the automatic features detection. This value is useless if BUILD_OPTS is set
[env: DEFAULT_FEATURES=]
--profile <PROFILE>
The default profile to build runtimes is always `release`. You may override the default with this flag
[env: PROFILE=]
[default: release]
--no-cache
Passing this flag allows completely disabling caching. As a result, no cargo-home will be mounted to the srtool image. There is no known issue with having the cache ON, this is why it is the default
--root
Run container image as root, this helps on Linux based systems
--verbose
Run the build script using the verbose option
-h, --help
Print help (see a summary with '-h')
-V, --version
Print version
If you landed here, you likely want to contribute the project. Let me thank you already. There are several ways you can help. Please start with the few notes below.
Whether you are reporting an issue you ran into or requesting a new feature, please open an issue here.
You know the drill: please try to provide some context information, the version you used, your OS, how to reproduce. That will greatly help solving your issue quicker.
The documentation of this project is mainly done using AsciiDoc. Unfortunately, it takes litterally ages for Github to support THE feature that makes AsciiDoc shine.
As a result, for now, this project is generating the markdwown from AsciiDoc. In short that means that you should NOT modify any .md file but change the .adoc ones and run just md to generate all the markdown.
This project is mainly using Rust so you will need to install the Rust compiler. Make sure everything works with the latest stable version of Rust.
You will find a justfile in the root of the repo. This is to be used with just so you may want to install that as well. Just type just 😁 to discover how it can help you.
Before submitting your code, do a cargo clippy stop to make sure everything works fine. Don’t forget to cargo fmt --all as well if you want to be friend with the CI. No surprise, the test can be ran using cargo test.
You may activate the logs for the project using RUST_LOG=debug for instance.
PRs are welcome. Feel free to open them early before putting too much effort (you may start with a draft). This way you can ping me (@chevdor) if you want my opinion on what and how you are putting your change together.