Skip to content

Latest commit

 

History

History
72 lines (43 loc) · 2.36 KB

quick_start.md

File metadata and controls

72 lines (43 loc) · 2.36 KB
Raw

Quick Start

Installation

In order to install Statue, simply run:

pip install statue

You can validate statue has been installed successfully by running:

statue --version

Which will print:

statue, version {{ version()  }}

Initialize Statue

In order for Statue to work correctly, you need to initialize Statue's configuration file. This is simply done by going to your project's root directory and using the command:

statue config init -i

This command will create statue.toml file with the relevant configurations. Just follow the instructions, and your Statue configuration file will be ready!

!!! note

The flag `-i` flag is important. It will make *Statue* install all commands added in the configuration.

You can see which commands have been set in your configuration using the command:

statue config show-tree

If you want to look at your configuration file as plain text, you can alternatively use:

statue config show

!!! note

When using `statue config init`, *Statue* will ask you to specify for each source which [contexts](contexts.md),
allowed commands and denied commands to apply to that source. If you are not sure how to respond, skip by pressing
enter. You'll always be able to edit your configuration later.

Run!

Now that your configuration file is ready, simply run:

statue run

And all the commands defined in the configuration will run on your codebase.

!!! note

When running `statue run`, *Statue* creates a cache directory named *.statue* which is saved in your project's
root directory. If you're using *git* as your VCS tool we highly recommend that you add *.statue* to your
*.gitignore* file.

Fixate Your Versions

We highly recommend fixing your commands versions in the configuration. This will make sure every developer working on your project uses the same command versions. You can do so by running:

statue config fix-versions

If you want to fix the versions of your commands to their latest available version, simply run:

statue config fix-versions --latest

What's Next?

  • Learn how to use statue run in various ways to improve efficiency
  • Learn how to use contexts in order to specify the way you want your formatters and linters to run
  • Learn how to edit your configuration file via command line