Welcome to Quickie Runner’s documentation!

• Introduction
  • Requirements
  • Per Project Installation
  • Global installation
  • Upgrading
  • Auto completion
  • Quick(ie)start
    • Defining tasks
    • Defining tasks in a package
• Task
  • Function based vs Class based tasks
  • Calling tasks from within run()
    • Return values
• Command
  • Environment variables
  • Exit codes
  • Timeout
  • Retry
  • Capturing output
• Script
  • Environment variables
  • Exit codes
  • Timeout
  • Retry
  • Capturing output
• Private tasks
• Task names and aliases
  • Name conflicts
• Namespaces
  • Using the @namespace decorator
  • The Namespace class
• Accepting arguments
  • Forcing positional arguments
  • Auto completion
  • Under the hood
• Conditions
  • FirstRun
  • FilesModified
  • PathsExist
  • All
  • Custom conditions
  • Combining conditions
  • Skipping conditions
• Running tasks in sequence
• Running Tasks in Parallel
• Dependencies and Cleanup
• How Tos:
  • Task Autocompletion
  • Custom Factories
  • Task Repository
• qk-mcp — MCP stdio server
  • Overview
  • Usage
  • Supported options
  • Project registration order
  • API
    • list_tasks
    • run_task
  • Multi-project example
• API
  • quickie
    • quickie.completion
      • quickie.completion.base
      • quickie.completion.python
    • quickie.conditions
      • quickie.conditions.base
    • quickie.config
    • quickie.context
    • quickie.errors
    • quickie.factories
    • quickie.mcp
    • quickie.tasks
    • quickie.utils
      • quickie.utils.argparser
      • quickie.utils.console
      • quickie.utils.imports
  • quickie.task
    • task()
  • quickie.script
    • script()
  • quickie.command
    • command()
  • quickie.Arg
    • Arg
      • Arg.__init__()
  • quickie.Namespace
    • Namespace
      • Namespace.__init__()
  • quickie.task_factory_helper
    • task_factory_helper()
  • quickie.group
    • group()
  • quickie.thread_group
    • thread_group()
  • quickie.load_env_file
    • load_env_file()
  • quickie.Context
    • Context
      • Context.__init__()
  • quickie.tasks.Task
    • Task
      • Task.__init__()
  • quickie.tasks.Script
    • Script
      • Script.__init__()
  • quickie.tasks.Command
    • Command
      • Command.__init__()
  • quickie.tasks.Group
    • Group
      • Group.__init__()
  • quickie.tasks.ThreadGroup
    • ThreadGroup
      • ThreadGroup.__init__()
  • quickie.completion
    • quickie.completion.base
    • quickie.completion.python
  • quickie.completion.BaseCompleter
    • BaseCompleter
      • BaseCompleter.__init__()
  • quickie.completion.PathCompleter
    • PathCompleter
      • PathCompleter.__init__()
  • quickie.completion.python
  • quickie.completion.python.PytestCompleter
    • PytestCompleter
      • PytestCompleter.__init__()
  • quickie.conditions
    • quickie.conditions.base
  • quickie.conditions.condition
    • condition()
  • quickie.conditions.FilesModified
    • FilesModified
      • FilesModified.__init__()
  • quickie.conditions.FirstRun
    • FirstRun
      • FirstRun.__init__()
  • quickie.conditions.PathsExist
    • PathsExist
      • PathsExist.__init__()
  • quickie.conditions.base
  • quickie.conditions.base.BaseCondition
    • BaseCondition
      • BaseCondition.__init__()
  • quickie.config
  • quickie.config.App
    • App
      • App.__init__()
  • quickie.context
  • quickie.context.Context
    • Context
      • Context.__init__()
  • quickie.errors
  • quickie.errors.QuickieError
    • QuickieError
  • quickie.errors.Stop
    • Stop
  • quickie.errors.TaskNotFoundError
    • TaskNotFoundError
  • quickie.errors.TasksModuleNotFoundError
    • TasksModuleNotFoundError
  • quickie.factories
  • quickie.factories.command
    • command()
  • quickie.factories.task_factory_helper
    • task_factory_helper()
  • quickie.factories.group
    • group()
  • quickie.factories.script
    • script()
  • quickie.factories.task
    • task()
  • quickie.factories.thread_group
    • thread_group()
  • quickie.utils
    • quickie.utils.argparser
    • quickie.utils.console
    • quickie.utils.imports
  • quickie.utils.argparser
  • quickie.utils.argparser.Arg
    • Arg
      • Arg.__init__()
  • quickie.utils.console
  • quickie.utils.console.QkConsole
    • QkConsole
      • QkConsole.__init__()
  • quickie.utils.imports
  • quickie.utils.imports.import_from_path
    • import_from_path()
• License

Indices and tables

• Index

• Module Index

• Search Page