Command Line Interface Overview
The Tideways command line interface simplifies tracing PHP console scripts and HTTP API requests for you.
You can prefix any php
, curl
, http
(httpie) or wget
command you want to trace with tideways run <app>
and it will set local environment variables for a PHP script or arguments to send HTTP headers with curl/wget.
Installation
See the Downloads page for more information on how to install it.
The tool is currently supported on both Linux and macOS. |
Setup
The first step to use the CLI is importing the settings for your account. Open
Commandline user settings
dialog and follow the instructions to call tideways import
.
tideways import <copy your generated token here>
[OK] Imported Settings for Tideways CLI.
You can now start profiling with 'tideways run <args>'
if you want generate
the settings
file for CLI in other directory as $HOME/.tideways then set the environment
variable export TIDEWAYS_SETTINGS_DIR='my directory' beforeĀ tideways
import .
|
Overview
The following output provides a short overview about the tideways command line tool. For more details about individual commands, see the related articles.
tideways --help
Tideways command-line utilities
Usage:
tideways [command]
Available Commands:
benchmark Run a benchmark against a list of URLs
event Manage events of a project
help Help about any command
import Import your profiling settings
list Print a list of all available projects
run Trigger profiling for a given command
trace Manage trace triggering rules of a project
version Print the version of Tideways CLI
Still need help?
Email [email protected]