Getting Started¶

New here? See Why afs new instead of func init? in the README for context on how this scaffolder differs from Azure Functions Core Tools.

Follow this guide to install the CLI and generate your first production-ready Azure Functions Python v2 project.

Ensure you have the following tools installed:

Python 3.10+: Supported versions are 3.10 through 3.13, plus 3.14 (Preview).
pip: Python package manager.
Azure Functions Core Tools: Required for local testing (v4.x recommended).

Install the CLI globally or in a virtual environment. Use pipx if you want to keep your global environment clean.

# Global install
pip install azure-functions-scaffold

# Recommended (Isolated install)
pipx install azure-functions-scaffold

Verify the installation by running the command or its alias:

afs --version

Run the new command to generate a standard HTTP project.

afs advanced new --preset standard my-api

Expected Output:

Created project at /path/to/my-api

Install the generated dependencies and start the local runtime.

cd my-api
pip install -e .
func start

Once the local runtime is ready, use curl to test the default HTTP trigger.

curl "http://localhost:7071/api/hello?name=Azure"

Expected Output:

Hello, Azure!

Learn how the code is organized in the Project Structure guide.