Welcome to Invoke’s documentation!

This site covers Invoke’s conceptual & API documentation. For basic info on what Invoke is, including its public changelog & how the project is maintained, please see the main project website.

Getting started

Many core ideas & API calls are explained in the tutorial/getting-started document:

• Getting started
  • Defining and running task functions
  • Task parameters
  • Listing tasks
  • Running shell commands
  • Declaring pre-tasks
  • Creating namespaces

The invoke CLI tool

Details on the CLI interface to Invoke, available core flags, and tab completion options.

• inv[oke] core usage
  • Core options and flags
  • Shell tab completion
    • Generating a completion script
    • Sourcing the script
    • Utilizing tab completion itself

Concepts

Dig deeper into specific topics:

• Configuration
  • Introduction
  • The configuration hierarchy
  • Default configuration values
  • Configuration files
  • Environment variables
  • Collection-based configuration
  • Example of real-world config use
• Invoking tasks
  • Basic command line layout
  • Task command-line arguments
  • How tasks run
• Using Invoke as a library
  • Reusing Invoke’s CLI module as a distinct binary
  • Customizing the configuration system’s defaults
• Loading collections
  • Task module discovery
  • Configuring the loading process
• Constructing namespaces
  • Starting out
  • Naming your tasks
  • Nesting collections
  • Importing modules as collections
  • Default tasks
  • Mix and match
  • More shortcuts
• Testing Invoke-using codebases
  • Subclass & modify Invoke ‘internals’
  • Use MockContext
  • Expect Results
  • Avoid mocking dependency code paths altogether
• Automatically responding to program output
  • Background
  • Basic use

API

Know what you’re looking for & just need API details? View our auto-generated API documentation:

• __init__
• collection
• config
• context
• exceptions
• executor
• loader
• parser
• program
• runners
• tasks
• terminals
• util
• watchers