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
Sub-Commands
| Command | Description |
|---|---|
restart | Restart Steampipe service |
start | Start Steampipe in service mode |
status | Status of the Steampipe service |
stop | Stop Steampipe service |
Flags
| Flag | Applies to | Description |
|---|---|---|
--dashboard | start | Start the dashboard web server with the database service |
--dashboard-listen string | start | Accept dashboard connections from: local (localhost only) or network (open) |
--dashboard-port int | start | Dashboard web server port (default 9194) |
--database-listen string | start | Accept database connections from: local (localhost only) or network (open) |
--database-password string | start | Set the steampipe database password for this session. See STEAMPIPE_DATABASE_PASSWORD for additional information |
--database-port int | start | Database service port (default 9193) |
--force | stop, restart | Forces the service to shutdown, releasing all open connections and ports |
--foreground | start | Run the service in the foreground |
--mod-location string | start | Sets the Steampipe workspace working directory. If not specified, the workspace directory will be set to the current working directory. See STEAMPIPE_MOD_LOCATION for details (only applies if '--dashboard' flag is also set) |
--show-password | start, status | View database password for connecting from another machine (default false) |
--var stringArray | start | Specify the value of a variable (only applies if '--dashboard' flag is also set) |
--var-file strings | start | Specify an .spvar file containing variable values (only applies if '--dashboard' flag is also set) |
--all | status | Bypass the --install-dir and print status of all running services |
Examples
Start Steampipe in the background (service mode):
Start Steampipe on port 9194
Start the Steampipe service with a custom password:
Start Steampipe on localhost only
Start Steampipe with dashboard
Start Steampipe with dashboard running on localhost only
Start Steampipe with dashboard running on port 9195
Stop the Steampipe service:
Forcefully kill all Steampipe services:
View Steampipe service status:
View Steampipe service status and display the database password:
View status of all running Steampipe services:
Restart the Steampipe service: