Various command-line interfaces are available, they share a lot of code and are all built using the same command.

Install

1. Install and configure go on your system
2. Clone the repo: git clone [<https://github.com/pathwar/pathwar>](<https://github.com/pathwar/pathwar>)
3. Build and install: cd pathwar; make install

pathwar CLI

pathwar is a CLI (command-line interface) used to communicate with the Pathwar services and perform various common actions. This CLI is made for humans and can be used as an alternative to the Pathwar web portal to perform various actions.

Some commands can be run by anyone, some others require specific permissions.

This CLI is mostly used by the Pathwar developers, feel free to run it and use it at your own risks, if you're unsure about what you're doing, just ask on Discord, or keep using the web portal.

See usage by running pathwar -h

pwinit

pwinit is injected into docker containers when using pathwar compose or pathwar agent commands.

It is used as an entrypoint that prepares a challenge to be compatible with the Pathwar engine.

pwcompose

Prepare a challenge for local testing: pathwar compose prepare --no-push path/to/challenge

Start a challenge from prepared yml file: pathwar compose up path/to/challenge.yml

Prepare and start a challenge for local testing: pathwar compose up --force-recreate <(pathwar compose prepare --no-push path/to/challenge)

pwagent

The Pathwar daemon that runs on a dedicated server and asks the API for jobs to perform to manages challenge instances.