🖥️ Command Line Interface
Start a New Project
usethis init— Initialize a new project with recommended defaults.
Manage Tooling
usethis arch— Add/Configure recommended architecture analysis tools (namely, Import Linter).usethis doc— Add/Configure recommended documentation tools (namely, MkDocs).usethis format— Add/Configure recommended formatters (namely, Ruff and pyproject-fmt).usethis hook— Add/Configure a recommended git hook framework (namely, pre-commit).usethis lint— Add/Configure recommended linters (namely, Ruff and deptry).usethis spellcheck— Add/Configure recommended spellcheckers (namely, codespell).usethis test— Add/Configure a recommended testing framework (namely, pytest with Coverage.py).usethis typecheck— Add/Configure a recommended type checker (namely, ty).usethis tool— Add/Configure specific tools individually.usethis tool codespell- Use the codespell spellchecker: detect common spelling mistakes.usethis tool deptry- Use the deptry linter: avoid missing or superfluous dependency declarations.usethis tool import-linter- Use Import Linter: enforce a self-imposed architecture on imports.usethis tool pre-commit- Use the pre-commit framework to manage and maintain Git hooks. Note that this will also install all the hooks to Git.usethis tool pyproject-fmt- Use the pyproject-fmt formatter: opinionated formatting of 'pyproject.toml' files.usethis tool ruff- Use Ruff: an extremely fast Python linter and code formatter.usethis tool tach- Use Tach: enforce self-imposed dependency and interface rules.usethis tool ty- Use ty: an extremely fast Python type checker.usethis tool coverage.py- Use Coverage.py: a code coverage measurement tool.usethis tool pytest- Use the pytest testing framework.usethis tool mkdocs- Use MkDocs: Generate project documentation sites with Markdown.usethis tool pyproject.toml- Use a pyproject.toml file to configure the project.usethis tool requirements.txt- Use a requirements.txt file exported from the uv lockfile.
Manage Configuration
usethis author— Set new author information for the project.usethis docstyle— Set a docstring style convention for the project, and enforce it with Ruff.usethis rule— Set linter rule configuration for specific rules across the project.usethis status— Set the development status of the project (via trove classifiers).
Manage the README
usethis badge— Add badges to the README file.usethis readme— Add a new README file.
Information
usethis list— Display a table of all available tools and their current usage status.usethis version— Display the current version of usethis.usethis browse pypi— Display or open the PyPI landing page associated with another project.usethis show— Show a specific piece of information about the project.usethis show backend- Show the inferred project manager backend, e.g. 'uv' or 'none'.usethis show license- Show the project license in SPDX format.usethis show name- Show the name of the project.usethis show sonarqube- Show appropriate contents of asonar-project.propertiesfile for SonarQube analysis.