The eest
CLI¶
eest¶
eest
is a CLI tool that helps with routine tasks.
Usage:
eest [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
eest clean¶
Remove all generated files and directories from the repository.
If --all
is specified, the virtual environment and .tox directory will also be removed.
Args:
all (flag): Remove the virtual environment and .tox directory as well.
dry_run (bool): Simulate the cleanup without removing files.
verbose (bool): Show verbose output.
Note: The virtual environment and .tox directory are not removed by default.
Example: Cleaning all generated files and directories and show the deleted items.
uv run eest clean --all -v
Output:
๐๏ธ Deleted: .tox
๐๏ธ Deleted: .venv
๐๏ธ Deleted: src/cli/et/__pycache__
๐๏ธ Deleted: src/cli/et/commands/__pycache__
๐๏ธ Deleted: src/cli/et/make/__pycache__
๐๏ธ Deleted: src/cli/et/make/commands/__pycache__
...
๐งน Cleanup complete!
Usage:
eest clean [OPTIONS]
Options:
--all Remove the virtual environment and .tox directory as well.
--dry-run Simulate the cleanup without removing files.
-v, --verbose Show verbose output.
--help Show this message and exit.
eest make¶
Generate project files.
Usage:
eest make [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
Subcommands
eest make env¶
A CLI command to generate the default environment file (env.yaml).
If an env.yaml
already exists, this command will NOT override it.
In that case, it is recommended to manually make changes.
Easter egg: Shows a random quote after creating the environment file.
Example:
uv run eest make env
Output:
๐ Success! Environment file created at: <path>/env.yaml
๐ Well begun is half done. - Aristotle
Usage:
eest make env [OPTIONS]
Options:
--help Show this message and exit.
eest make test¶
Generate a new test file for an EIP.
This function guides the user through a series of prompts to generate a test file for Ethereum execution specifications. The user is prompted to select the type of test, the fork to use, and to provide the EIP number and name. Based on the inputs, a test file is created in the appropriate directory with a rendered template.
Prompts:
-
Choose the type of test to generate (State or Blockchain)
-
Select the fork where this functionality was introduced
-
Enter the EIP number
-
Enter the EIP name
Example:
uv run eest make test
Usage:
eest make test [OPTIONS]
Options:
--help Show this message and exit.