CLI commands

Zuora Workflow Manager provides several Artisan commands to manage the application from the terminal.

Workflow commands

app:sync-workflows

Synchronizes workflows from Zuora API to local database. Signature:

php artisan app:sync-workflows {--customer=} {--all} {--sync}

Options:

--customer=NAME: Synchronize only the specified customer
--all: Synchronize all customers
--sync: Execute synchronously (no queue)

Examples:

# Synchronize all customers (asynchronous with queue)
lando artisan app:sync-workflows --all

# Synchronize a specific customer
lando artisan app:sync-workflows --customer="Acme Corp"

# Synchronize all customers synchronously (no queue)
lando artisan app:sync-workflows --all --sync

# Synchronize a customer synchronously
lando artisan app:sync-workflows --customer="Acme Corp" --sync

Output:

Queuing sync jobs for 3 customers...

✓ Sync job queued for: Acme Corp
✓ Sync job queued for: Beta Inc
✓ Sync job queued for: Gamma LLC

All jobs queued successfully. Monitor with:
  php artisan queue:work
  php artisan queue:monitor

Notes:

Asynchronous mode (default): Queues job for background processing
Synchronous mode (--sync): Executes immediately, blocks terminal
Requires active queue worker for asynchronous mode

workflows:sync-tasks

Synchronizes tasks from workflow JSON already present in the database. Signature:

php artisan workflows:sync-tasks {--all} {--workflow-id=}

Options:

--all: Synchronize tasks for all workflows
--workflow-id=ID: Synchronize tasks for a specific workflow

Examples:

# Synchronize tasks for all workflows
lando artisan workflows:sync-tasks --all

# Synchronize tasks for a specific workflow
lando artisan workflows:sync-tasks --workflow-id=123

When to use:

After modifications to syncTasksFromJson() method
To rebuild tasks from existing JSON
For troubleshooting missing tasks

Notes:

Does not download new workflows from Zuora
Uses only JSON already present in database
Useful for re-processing after bug fixes

Queue commands

queue:work

Starts a queue worker to process jobs. Signature:

php artisan queue:work [connection] [options]

Common options:

--queue=QUEUE: Specify queue to process
--tries=N: Maximum number of attempts (default: 1)
--timeout=N: Timeout in seconds (default: 60)
--sleep=N: Seconds to sleep when queue is empty (default: 3)
--max-time=N: Maximum execution time in seconds
--max-jobs=N: Maximum number of jobs to process
--verbose: Detailed output

Examples:

# Basic worker
lando artisan queue:work

# Worker with retry and timeout
lando artisan queue:work --tries=3 --timeout=120

# Verbose worker for debugging
lando artisan queue:work --verbose

# Worker with time limit
lando artisan queue:work --max-time=3600

# Worker for specific queue
lando artisan queue:work --queue=high-priority

Lando shortcut:

lando queue  # Equivalent to: lando artisan queue:work --verbose

Output:

[2024-01-01 10:00:00][1] Processing: App\\Jobs\\SyncCustomersJob
[2024-01-01 10:00:05][1] Processed:  App\\Jobs\\SyncCustomersJob

queue:listen

Starts a queue listener (automatically restarts after each job). Signature:

php artisan queue:listen [connection] [options]

Difference with queue:work:

queue:work: More efficient, doesn’t reload framework
queue:listen: Reloads framework after each job, useful for development

Example:

lando artisan queue:listen --tries=1

queue:failed

Displays failed jobs. Signature:

php artisan queue:failed

Output:

+------+---------------------------+-------+------------+---------------------+
| ID   | Connection                | Queue | Class      | Failed At           |
+------+---------------------------+-------+------------+---------------------+
| 1    | database                  | default| SyncCustom...| 2024-01-01 10:00:00|
+------+---------------------------+-------+------------+---------------------+

queue:retry

Retries failed jobs. Signature:

php artisan queue:retry {id|all}

Examples:

# Retry all failed jobs
lando artisan queue:retry all

# Retry a specific job
lando artisan queue:retry 1

# Retry multiple jobs
lando artisan queue:retry 1 2 3

queue:flush

Deletes all failed jobs. Signature:

php artisan queue:flush

Example:

lando artisan queue:flush

Warning: This operation is irreversible!

queue:forget

Deletes a specific failed job. Signature:

php artisan queue:forget {id}

Example:

lando artisan queue:forget 1

Scheduler commands

schedule:work

Starts the scheduler in foreground mode. Signature:

php artisan schedule:work

Example:

lando schedule  # Lando shortcut

Output:

[2024-01-01 10:00:00] Running scheduled command: app:sync-workflows --all
[2024-01-01 10:00:05] Scheduled command completed successfully

Notes:

Executes scheduled tasks every minute
Useful for development
In production use cron job

schedule:list

Displays all scheduled tasks. Signature:

php artisan schedule:list

Output:

0 * * * * php artisan app:sync-workflows --all ... Next Due: 1 hour from now

schedule:run

Executes scheduled tasks once (used by cron). Signature:

php artisan schedule:run

Production cron job:

* * * * * cd /path/to/app && php artisan schedule:run >> /dev/null 2>&1

Database commands

migrate

Executes database migrations. Signature:

php artisan migrate [options]

Options:

--force: Force execution in production
--seed: Run seeders after migrations
--step: Execute one migration at a time

Examples:

# Execute all migrations
lando artisan migrate

# Execute with seeders
lando artisan migrate --seed

# Force in production
lando artisan migrate --force

migrate:fresh

Drops all tables and re-executes migrations. Signature:

php artisan migrate:fresh [options]

Options:

--seed: Run seeders after migrations

Example:

lando artisan migrate:fresh --seed

Warning: Deletes all data!

migrate:rollback

Rollback the last batch of migrations. Signature:

php artisan migrate:rollback [options]

Options:

--step=N: Rollback N batches

Example:

lando artisan migrate:rollback --step=1

db:seed

Executes database seeders. Signature:

php artisan db:seed [options]

Options:

--class=CLASS: Execute a specific seeder

Example:

lando artisan db:seed
lando artisan db:seed --class=UserSeeder

Cache commands

cache:clear

Clears application cache. Signature:

php artisan cache:clear

Example:

lando artisan cache:clear

config:clear

Clears configuration cache. Signature:

php artisan config:clear

Example:

lando artisan config:clear

view:clear

Clears compiled view cache. Signature:

php artisan view:clear

Example:

lando artisan view:clear

route:clear

Clears route cache. Signature:

php artisan route:clear

Example:

lando artisan route:clear

optimize:clear

Clears all caches (config, route, view, cache). Signature:

php artisan optimize:clear

Example:

lando artisan optimize:clear

Filament commands

make:filament-user

Creates a new Filament user. Signature:

php artisan make:filament-user

Example:

lando artisan make:filament-user

Interactive prompt:

Name: John Doe
Email: john@example.com
Password: ********

shield:generate

Generates permissions for Filament Shield. Signature:

php artisan shield:generate [options]

Options:

--all: Generate for all resources

Example:

lando artisan shield:generate --all

Utility commands

tinker

Starts interactive REPL. Signature:

php artisan tinker

Example:

lando artisan tinker

>>> $customer = Customer::first()
>>> $customer->workflows()->count()
=> 42

about

Displays application information. Signature:

php artisan about

Output:

Environment ............... local
Debug Mode ................ ENABLED
URL ....................... https://zuora-workflows.lndo.site
Database .................. mariadb
Cache Driver .............. redis
Queue Driver .............. database

list

Displays all available commands. Signature:

php artisan list

Composer scripts

composer run dev

Starts complete development stack. Command:

lando composer run dev

Executes:

php artisan serve (server)
php artisan queue:listen (queue)
php artisan pail (logs)
yarn run dev (vite)

Notes: Uses concurrently to run all processes in parallel.

composer run test

Executes tests. Command:

lando composer run test

Equivalent to:

lando artisan config:clear
lando artisan test

composer run setup

Complete application setup. Command:

lando composer run setup

Executes:

composer install
Copy .env.example to .env
php artisan key:generate
php artisan migrate --force
yarn install
yarn run build

Best practices

Development

# Start queue worker in one window
lando queue

# Start scheduler in another window
lando schedule

# Monitor logs in another window
lando logs -f

Production

# Setup cron for scheduler
* * * * * cd /path/to/app && php artisan schedule:run >> /dev/null 2>&1

# Setup Supervisor for queue worker
# See /deployment/queue-worker

Troubleshooting

# Clear all caches
lando artisan optimize:clear

# Check failed jobs
lando artisan queue:failed

# Retry failed jobs
lando artisan queue:retry all

# Check configuration
lando artisan about

Next steps

Testing

Testing guide

Troubleshooting

Problem resolution

Deployment

Production deployment

Zuora API

Zuora API details

Overview

Getting started

Architecture

Features

Developer guide

API reference

​CLI commands

​Workflow commands

​app:sync-workflows

​workflows:sync-tasks

​Queue commands

​queue:work

​queue:listen

​queue:failed

​queue:retry

​queue:flush

​queue:forget

​Scheduler commands

​schedule:work

​schedule:list

​schedule:run

​Database commands

​migrate

​migrate:fresh

​migrate:rollback

​db:seed

​Cache commands

​cache:clear

​config:clear

​view:clear

​route:clear

​optimize:clear

​Filament commands

​make:filament-user

​shield:generate

​Utility commands

​tinker

​about

​list

​Composer scripts

​composer run dev

​composer run test

​composer run setup

​Best practices

​Development

​Production

​Troubleshooting

​Next steps

Testing

Troubleshooting

Deployment

Zuora API

CLI commands

Workflow commands

app:sync-workflows

workflows:sync-tasks

Queue commands

queue:work

queue:listen

queue:failed

queue:retry

queue:flush

queue:forget

Scheduler commands

schedule:work

schedule:list

schedule:run

Database commands

migrate

migrate:fresh

migrate:rollback

db:seed

Cache commands

cache:clear

config:clear

view:clear

route:clear

optimize:clear

Filament commands

make:filament-user

shield:generate

Utility commands

tinker

about

list

Composer scripts

composer run dev

composer run test

composer run setup

Best practices

Development

Production

Troubleshooting

Next steps