steampipe service

Steampipe service management.

steampipe service allows you to run Steampipe as a local service, exposing it as a database endpoint for connection from any Postgres-compatible database client.

Usage

steampipe service [command]

Sub-Commands

CommandDescription
restartRestart Steampipe service
startStart Steampipe in service mode
statusStatus of the Steampipe service
stopStop Steampipe service

Flags

FlagApplies toDescription
--database-listen stringstartAccept database connections from: local (localhost only) or network (open)
--database-password stringstartSet the steampipe database password for this session. See STEAMPIPE_DATABASE_PASSWORD for additional information
--database-port intstartDatabase service port (default 9193)
--forcestop, restartForces the service to shutdown, releasing all open connections and ports
--foregroundstartRun the service in the foreground
--show-passwordstart, statusView database password for connecting from another machine (default false)
--allstatusBypass the --install-dir and print status of all running services

Examples

Start Steampipe in the background (service mode):

steampipe service start

Start Steampipe on port 9194

steampipe service start --database-port 9194

Start the Steampipe service with a custom password:

steampipe service start --database-password MyCustomPassword

Start Steampipe on localhost only

steampipe service start --database-listen local

Stop the Steampipe service:

steampipe service stop

Forcefully kill all Steampipe services:

steampipe service stop --force

View Steampipe service status:

steampipe service status

View Steampipe service status and display the database password:

steampipe service status --show-password

View status of all running Steampipe services:

steampipe service status --all

Restart the Steampipe service:

steampipe service restart