Installation
Install fsg as a standalone tool, or run it once without installing anything.
Notefsg has no dependencies. git is optional and only needed to respect
.gitignore.#Requirements
#Install
-
Install the tool
$ uv tool install fsg$ pipx install fsg$ pip install fsg -
Check the version
$ fsg --version fsg 0.4.0 -
Print your first tree
Run fsg in your project. Without a path it renders the current directory.
$ fsg --depth 1 --no-fence fsg/ ├── .github/ ├── assets/ ├── docs/ ├── site/ ├── src/ ├── tests/ ├── .gitattributes ├── .gitignore ├── .pre-commit-hooks.yaml ├── CHANGELOG.md ├── LICENSE ├── pyproject.toml └── README.md
#Run without installing
uvx downloads fsg into a cache and runs it. This also works on Windows and in CI.
$ uvx fsg --check README.md #Update and remove
| Installed with | Update | Remove |
|---|---|---|
| uv | uv tool upgrade fsg |
uv tool uninstall fsg |
| pipx | pipx upgrade fsg |
pipx uninstall fsg |
| pip | pip install -U fsg |
pip uninstall fsg |