Gateway facilitating asyncronous communication between sensory data-emitting devices, InfluxDB and the user.
Project description
influx-cli
CLI for managing resources in InfluxDB v2
Motivation
This repository decouples the influx
CLI from the OSS influxdb
codebase. Our goals are to:
- Make it easier to keep the CLI up-to-date with InfluxDB Cloud API changes
- Enable faster turn-around on fixes/features that only affect the CLI
- Allow the CLI to be built & released for a wider range of platforms than the server can support
Building the CLI
Follow these steps to build the CLI. If you're updating your CLI build, see Updating openapi below.
-
Clone this repo (influx-cli) and change to your influx-cli directory.
git clone git@github.com:influxdata/influx-cli.git cd influx-cli
-
Build the CLI. The
make
andmake influx
commands write the new binary tobin/$(GOOS)/influx
.make
Updating openapi
If you change or update your branch, you may also need to update influx-cli/openapi
and regenerate the client code.
influx-cli/openapi
is a Git submodule that contains the underlying API contracts and client used by the CLI.
We use OpenAPITools/openapi-generator
to generate
the HTTP client.
To update, run the following commands in your influx-cli
repo:
-
Update the openapi Git submodule. The following command pulls the latest commits for the branch and all submodules.
git pull --recurse-submodules
-
With Docker running locally, regenerate openapi.
make openapi
-
Rebuild the CLI
make
Running the CLI
After building, use influx -h
to see the list of available commands.
Enabling Completions
The CLI supports generating completions for bash
, zsh
, and powershell
. To enable completions for a
single shell session, run one of these commands:
# For bash:
source <(influx completion bash)
# For zsh:
source <(influx completion zsh)
# For pwsh:
Invoke-Expression ((influx completion powershell) -join "`n`")
To enable completions across sessions, add the appropriate line to your shell's login profile (i.e. ~/.bash_profile
).
Testing
Run make test
to run unit tests.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for async_httpd_data_collector-0.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | af6a83a6ee8116b3debc0203ed9bcaeebbc1556d3de244d38bbb4742bb579bac |
|
MD5 | 29a8479df393b8faed201a077a8d5018 |
|
BLAKE2b-256 | 26a0a777a3746ccc1fbc6ad6454c3b645a2eb41b5eeda63c2e2e984e5c978eb4 |
Hashes for async_httpd_data_collector-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dc593ad3880b9de89cffd713787000c174a22bf94a0f39f382586f4bc5ed8574 |
|
MD5 | 1ecf4fd36724bb9232cda80e59107baa |
|
BLAKE2b-256 | 757baceb47c90a9a92aacfaf3f7aad10edfc4aa1a39d66e6076c53f0ba0b43b9 |