AgentX
Menu

Task Commands

Complete reference for Taskfile automation commands.

Installation & Setup

Install All Dependencies

task install

Runs uv sync and bun install to install all dependencies.

Initialize Databases

task db:init

Creates data directories for Neo4j, PostgreSQL, and Redis.

Development

Start Development Environment

task dev

Starts all services:

  • Docker containers (Neo4j, Postgres, Redis)
  • Django API on port 12319
  • Tauri development window

Start Services Only

task runners

Starts Docker containers without API or client.

Stop All Services

task teardown

Stops and removes Docker containers.

Pre-Launch Check

task pre-launch-check

Validates that all required directories and dependencies exist.

API Commands

Run Django Server

task api:runserver

Starts Django development server on http://127.0.0.1:12319.

Django Shell

task api:shell

Opens Django interactive shell.

Database Migrations

Create migration files:

task api:makemigrations

Apply migrations:

task api:migrate

Client Commands

Start Tauri Dev Mode

task client:dev

Launches Tauri window with hot reload.

Build Client

task client:build

Builds production client bundle.

Start Production Client

task client:start

Runs production build (requires client:build first).

Database Management

PostgreSQL

Open PostgreSQL shell:

task db:shell:postgres

Create backup:

task db:backup:postgres

Backups saved to ./backups/postgres_YYYYMMDD_HHMMSS.sql

Restore from backup:

task db:restore:postgres BACKUP_FILE=backups/postgres_20231127_120000.sql

Redis

Open Redis CLI:

task db:shell:redis

Neo4j

Neo4j Browser: http://localhost:7474

Volume Migration

Migrate all databases from Docker volumes to local bind mounts:

task db:migrate-volumes

Migrate individual databases:

task db:migrate-volumes:neo4j
task db:migrate-volumes:postgres
task db:migrate-volumes:redis

These commands copy data from Docker volumes to ./data/ directories.

Clean All Data

task db:clean

You will be prompted for confirmation.

Testing

Run All Tests

task test

Runs Django test suite.

Run Specific Test

uv run python api/manage.py test agentx_ai.TranslationKitTest

Run Single Test Method

uv run python api/manage.py test agentx_ai.TranslationKitTest.test_translate_to_french

Documentation

Serve Documentation Locally

task docs:serve

Opens documentation at http://127.0.0.1:8000 with live reload.

Build Documentation

task docs:build

Builds static documentation site to site/ directory.

Deploy Documentation

task docs:deploy

Deploys documentation to GitHub Pages (requires git repository setup).

Utility Commands

Default Task

task

Runs sanity check and prompts to start development environment.

List All Tasks

task --list

Shows all available tasks with descriptions.

Task Help

task --help

Displays Taskfile help information.

Task Dependencies

Some tasks automatically run prerequisites:

  • task dev → runs task runners first
  • task client:start → runs task client:build first
  • task runners → runs task pre-launch-check first

Environment-Specific Tasks

Development

# Quick iteration cycle
task dev              # Start everything
# Make changes...
task test             # Verify changes
task teardown         # Stop when done

Testing

# Run specific tests during development
uv run python api/manage.py test agentx_ai --keepdb

Production Build

task client:build     # Build optimized client
task api:migrate      # Ensure migrations are applied

Custom Task Variables

Some tasks accept variables:

Postgres Restore

task db:restore:postgres BACKUP_FILE=path/to/backup.sql

Debugging Tasks

Verbose Output

task --verbose dev

Dry Run

task --dry dev

Shows what would be executed without running commands.

Tips & Tricks

Run Multiple Commands

task install && task db:init && task dev

Background Execution

task runners &  # Start services in background

Watch Mode

# API auto-reloads on file changes
task api:runserver

# Client has HMR enabled
task client:dev

Quick Database Reset

task teardown && task db:clean && task db:init && task runners

Next Steps