Warlock CLI

About 1 min

Warlock CLI

The warlock tool is included with Hazaar and provides functionality for managing and interacting with Warlock servers, agents, and authentication users.

Usage

You can run the Warlock CLI from your project using:

vendor/bin/warlock

Example output:

Warlock v1.0.0
Environment: development
Hazaar Console Application
Usage: warlock [GLOBAL OPTIONS]  [COMMAND OPTIONS]

To see available commands and options:

vendor/bin/warlock help

Global Options

--env, -e: The environment to use. Overrides APPLICATION_ENV.
--path, -p: Path to the application. Defaults to the current directory.

Command Reference

`help`

Display help information for a command:

vendor/bin/warlock help [command]

`run`

Start the Warlock server using a config file:

vendor/bin/warlock run --config configs/warlock.json

`stop`

Stop the Warlock server (when running as a background process):

vendor/bin/warlock stop

`restart`

Restart the Warlock server (when running as a background process):

vendor/bin/warlock restart

`agent`

Manage the Warlock agent, which connects to the server and executes delayed jobs, services, and event handlers.

To see agent subcommands:

vendor/bin/warlock help agent

Agent Subcommands

`agent run`

Start the Warlock agent:

vendor/bin/warlock agent run --path /path/to/app

`agent stop`

Stop the Warlock agent:

vendor/bin/warlock agent stop

`agent restart`

Restart the Warlock agent:

vendor/bin/warlock agent restart

`user`

Manage users in the Warlock authentication database (basic auth mode).

To see user subcommands:

vendor/bin/warlock help user

User Subcommands

`user list`

List users in the authentication database:

vendor/bin/warlock user list --dbfile /var/warlock/auth.db

`user add`

Add a user:

vendor/bin/warlock user add alice --password 'S3curePass!' --dbfile /var/warlock/auth.db

`user del`

Delete a user:

vendor/bin/warlock user del alice --yes --dbfile /var/warlock/auth.db

`user check`

Check whether a username/password can authenticate:

vendor/bin/warlock user check alice 'S3curePass!' --dbfile /var/warlock/auth.db

Tips

Use vendor/bin/warlock help for the most accurate command list in your installed version.