README
¶
Steampipe CLI quick start
- Get started →
- Install your favorite plugins
- Documentation: Table definitions & examples
- Community: Slack Channel
- Get involved: Issues
Developing
Prerequisites:
- Golang Version 1.17 or higher.
Clone:
git clone git@github.com:turbot/steampipe
cd steampipe
Build, which automatically installs the new version to your /usr/local/bin/steampipe directory:
make
Check the version
$ steampipe -v
steampipe version 0.10.0
Install a plugin
$ steampipe plugin install steampipe
Try it!
steampipe query
> .inspect steampipe
+-----------------------------------+-----------------------------------+
| TABLE | DESCRIPTION |
+-----------------------------------+-----------------------------------+
| steampipe_registry_plugin | Steampipe Registry Plugins |
| steampipe_registry_plugin_version | Steampipe Registry Plugin Version |
+-----------------------------------+-----------------------------------+
> select * from steampipe_registry_plugin;
Contributing
Please see the contribution guidelines and our code of conduct. All contributions are subject to the AGPLv3 open source license.
Guides:
help wanted issues:
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cmd contains Cobra command definitions for all Steampipe commands
|
Package cmd contains Cobra command definitions for all Steampipe commands |
|
pkg
|
|
|
cloud
Package cloud contains logic to support connecting to a steampipe cloud database
|
Package cloud contains logic to support connecting to a steampipe cloud database |
|
cmdconfig
Package cmd_config contains helper functions to support constructing Cobra commands, validating arguments and populating Viper config management
|
Package cmd_config contains helper functions to support constructing Cobra commands, validating arguments and populating Viper config management |
|
connectionwatcher
Package connection_watcher contains logic and types to support file-watching Steampipe connection config
|
Package connection_watcher contains logic and types to support file-watching Steampipe connection config |
|
constants
Package constants contains constant values that are used throughout Steampipe
|
Package constants contains constant values that are used throughout Steampipe |
|
version
Package version :: The version package provides a location to set the release versions for all packages to consume, without creating import cycles.
|
Package version :: The version package provides a location to set the release versions for all packages to consume, without creating import cycles. |
|
grpc/shared
Package shared contains shared data between the host and plugins.
|
Package shared contains shared data between the host and plugins. |
|
ui
|
|
Click to show internal directories.
Click to hide internal directories.