Jump to Content
PantsDocsCommunityTestimonialsUsersGitHubTwitterBlogJobs
HomeDocs
DocsCommunityTestimonialsUsersGitHubTwitterBlogJobsTermsPrivacyCookiesPants
TermsPrivacyCookies

Introduction

  • Welcome to Pants!
  • How does Pants work?
  • Language support
  • Who uses Pants
  • Testimonials
  • Resource hub
  • News room

Getting Started

  • Getting started
    • Prerequisites
    • Installing Pants
    • Initial configuration
    • Example projects and repositories
    • Incremental adoption
    • Manual and advanced installation

Getting Help

  • Getting help
  • The Pants community
    • Code of conduct
    • Meet the Team
    • Maintainers
    • Contentious decisions
  • Service providers

Using Pants

  • Key concepts
    • Goals
    • Targets and BUILD files
    • Options
    • Backends
    • Source roots
  • Command line help
  • Troubleshooting / common issues
  • Advanced target selection
  • Project introspection
  • Assets and archives
  • Using Pants in CI
  • Restricted Internet access
  • Anonymous telemetry
  • Remote caching & execution
    • Remote caching
    • Remote execution
  • Setting up an IDE

Python

  • Python overview
    • Enabling Python support
    • Third-party dependencies
    • Interpreter compatibility
    • Linters and formatters
    • Pex files
    • Building distributions
  • Goals
    • check
    • fmt
    • lint
    • package
    • repl
    • run
    • test
  • Integrations
    • Protobuf and gRPC
    • Thrift
    • AWS Lambda
    • Google Cloud Functions
    • PyOxidizer
    • Jupyter

Go

  • Go overview
  • Integrations
    • Protobuf

Java and Scala

  • Java and Scala overview

Shell

  • Shell overview
  • Run shell commands

Docker

  • Docker overview
  • Tagging Docker images

Helm

  • Helm Overview

Writing Plugins

  • Plugins overview
  • Macros
  • The Target API
    • Concepts
    • Creating new fields
    • Creating new targets
    • Extending existing targets
  • The Rules API
    • Concepts
    • Goal rules
    • Options and subsystems
    • File system
    • Processes
    • Installing tools
    • Rules and the Target API
    • Union rules (advanced)
    • Logging and dynamic output
    • Testing plugins
    • Tips and debugging
  • Common plugin tasks
    • Add a linter
    • Add a formatter
    • Add a typechecker
    • Add codegen
    • Add a REPL
    • Custom `python_artifact()` kwargs
    • Plugin upgrade guide

Releases

  • Changelog
  • Deprecation policy
  • Upgrade tips

Contributions

  • Contribution overview
  • Development
    • Setting up Pants
    • Style guide
    • Developing Rust
    • Internal architecture
    • Debugging and benchmarking
    • Running Pants from sources
  • Releases
    • Release strategy
    • Release process
    • GitHub Actions macOS ARM64 runners

Reference

  • Global options
  • Goals
    • check
    • count-loc
    • dependees
    • dependencies
    • experimental-bsp
    • export
    • export-codegen
    • filedeps
    • filter
    • fmt
    • generate-lockfiles
    • help
    • help-advanced
    • help-all
    • lint
    • list
    • package
    • paths
    • peek
    • publish
    • py-constraints
    • repl
    • roots
    • run
    • tailor
    • test
    • update-build-files
    • version
  • Subsystems
    • anonymous-telemetry
    • apache-thrift
    • autoflake
    • bandit
    • black
    • buf
    • changed
    • cli
    • coursier
    • coverage-py
    • docformatter
    • docker
    • dockerfile-parser
    • download-terraform
    • flake8
    • go-test
    • gofmt
    • golang
    • google-java-format
    • grpc-python-plugin
    • hadolint
    • helm
    • helm-unittest
    • ipython
    • isort
    • java-infer
    • javac
    • junit
    • jvm
    • kotlin
    • kotlin-infer
    • kotlinc
    • ktlint
    • lambdex
    • mypy
    • mypy-protobuf
    • pex
    • pex-binary-defaults
    • pex-cli
    • poetry
    • protoc
    • pylint
    • pyoxidizer
    • pytest
    • python
    • python-bootstrap
    • python-infer
    • python-native-code
    • python-protobuf
    • python-repos
    • python-thrift
    • pyupgrade
    • regex-lint
    • scala
    • scala-infer
    • scalac
    • scalafmt
    • scalapb
    • scalatest
    • scc
    • setup-py-generation
    • setuptools
    • shell-setup
    • shellcheck
    • shfmt
    • source
    • stats
    • subprocess-environment
    • terraform-fmt
    • terraform-hcl2-parser
    • terraform-validate
    • thrift
    • twine
    • yapf
  • Targets
    • archive
    • deploy_jar
    • docker_image
    • experimental_run_shell_command
    • experimental_shell_command
    • file
    • files
    • go_binary
    • go_mod
    • go_package
    • go_third_party_package
    • helm_artifact
    • helm_chart
    • helm_unittest_test
    • helm_unittest_tests
    • java_source
    • java_sources
    • junit_test
    • junit_tests
    • jvm_artifact
    • jvm_war
    • kotlin_source
    • kotlin_sources
    • kotlinc_plugin
    • pants_requirements
    • pex_binaries
    • pex_binary
    • pipenv_requirements
    • poetry_requirements
    • protobuf_source
    • protobuf_sources
    • pyoxidizer_binary
    • python_awslambda
    • python_distribution
    • python_google_cloud_function
    • python_requirement
    • python_requirements
    • python_source
    • python_sources
    • python_test
    • python_test_utils
    • python_tests
    • relocated_files
    • resource
    • resources
    • scala_junit_test
    • scala_junit_tests
    • scala_source
    • scala_sources
    • scalac_plugin
    • scalatest_test
    • scalatest_tests
    • shell_source
    • shell_sources
    • shunit2_test
    • shunit2_tests
    • target
    • terraform_module
    • thrift_source
    • thrift_sources
Powered by 

Getting started

Suggest Edits

Thanks for your interest in trying out Pants!

We recommend joining our Slack workspace, in case you have any questions along the way.

And if you want to show support for the project, GitHub stars are always appreciated!

  • Prerequisites
  • Installing Pants
  • Initial configuration
  • Example repositories
  • Incremental adoption

Updated 7 months ago