pscale shell <mydatabase> <mybranch>

Open a MySQL shell instance to a database and branch

Arguments

NameDescription
mydatabase
mybranch

Options

NameDescription
--help, -hShow help
--api-token <string>The API token to use for authenticating against the PlanetScale API
--api-url <string>The base URL for the PlanetScale API. (default "https://api.planetscale.com/")
--config <string>Config file (default is $HOME/.config/planetscale/pscale.yml)
--debugEnable debug mode
--format, -f <string>Show output in a specific format. Possible values: [human, json, csv] (default "human")
--no-colorDisable color output
--service-token <string>Service Token for authenticating
--service-token-name <string>The Service Token name for authenticating
--port <string>Local port to bind and listen for connections (default "3306")
--remote-addr <string>PlanetScale Database remote network address. By default the remote address is populated automatically from the PlanetScale API
--local-addr <string>Local address to bind and listen for connections. By default the proxy binds to 127.0.0.1 with a random port