CLI
Werk24 provides a command-line interface (CLI) for interacting with the API directly from your terminal.
Getting Started
To explore the available commands and options, run:
This will display a help menu with available commands and options:
| Usage: werk24 [OPTIONS] COMMAND [ARGS]...
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────╮
│ --log-level <str> Set the log level [default: WARNING] │
│ --install-completion Install completion for the current shell. │
│ --show-completion Show completion for the current shell, to copy it or │
│ customize the installation. │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────╮
│ init Initialize Werk24 by providing or creating a license token. │
│ health-check Run a comprehensive health check for the CLI. │
│ techread Read a drawing file and extract information. │
│ version Print the version of the Client. │
│ status Fetch and display the Werk24 system status. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
|
Check system status
To verify that the Werk24 API is operational, run the status command:
This prints a JSON summary describing the current system health.
See the SystemStatus reference for field details.
For continuous monitoring and alerting examples, check out System Status Monitoring.
Sending your first request
To extract information from a technical drawing, use the techread command. Simply specify the type of Ask you need and provide the file path.
| $> werk24 techread --ask-meta-data <path>
|
The CLI will then process the file and display the extracted information in the terminal.