CLI

A CLI built for Apitax supporting Commandtax and Scriptax. It will also handle any and all authentication along the way

Installation and Usage

• Clone this repository and run pip install .
  • It is recommended to use a Python virtual environment for this, but it is not mandatory
• Run apitax commands

Commands

• apitax --help
  • In fact any sub command with --help attached will show you how to use the command
    • apitax --help -> apitax script --help -> apitax script execute --help

Documentation for API Endpoints

All URIs are relative to https://localhost/apitax/2

Class	Method	HTTP request	Description
AdminsApi	display_admin_dashboard	GET /dashboard/admin	Displays the developer admin page
AdminsApi	driver_status	GET /system/driver/{name}/status	Retrieve the status of a loaded driver
AdminsApi	system_status	GET /system/status	Retrieve the system status
AnyApi	authenticate	POST /auth	Authenticate
AnyApi	display_login	GET /login	Displays the login page
AnyApi	get_asset	GET /assets/{name}	Displays the user dashboard page
AnyApi	refresh_token	POST /token/refresh	Refreshes login token using refresh token
DevelopersApi	create_script	POST /system/script	Create a new script
DevelopersApi	delete_script	DELETE /system/script	Delete a script
DevelopersApi	display_developer_dashboard	GET /dashboard/developer	Displays the developer dashboard page
DevelopersApi	rename_script	PATCH /system/script	Rename a script
DevelopersApi	save_script	PUT /system/script	Save a script
UsersApi	command	POST /command	Execute a Command
UsersApi	display_dashboard	GET /dashboard	Displays the user dashboard page
UsersApi	endpoint_catalog	GET /system/endpoint/catalog	Retrieve the endpoint catalog
UsersApi	get_script	GET /system/script	Retrieve the contents of a script
UsersApi	script_catalog	GET /system/script/catalog	Retrieve the script catalog

Documentation For Models

• AuthResponse
• Command
• Create
• Delete
• ErrorResponse
• Execute
• Rename
• Response
• Save
• Script
• UserAuth

Author

shawn.clake@nopatience.net