influxdata / influxdata/docs-v2

Add instructions on how to access the CLI

Open
#4,041 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

low-priority OSS source:feedback
Dominant language
JavaScript
Stars
82
Forks
326
Avg merge
1d 1h
Merged PRs (30d)
82

Description

Customer was not sure how to install the CLI. I believe they mean "access the CLI". They were reading this doc "influx - InfluxDB command line interface":
https://docs.influxdata.com/influxdb/v1.8/tools/influx-cli/

The instructions on how to use the CLI are here:

https://docs.influxdata.com/influxdb/v1.8/tools/shell/#launch-influx

To access the CLI, first launch the influxd database process and then launch influx in your terminal. Once you’ve entered the shell and successfully connected to an InfluxDB node, you’ll see the following output:
$ influx
Connected to http://localhost:8086 version 1.8.10
InfluxDB shell version: 1.8.10
Change InfluxDB URL
Note: The versions of InfluxDB and the CLI should be identical. If not, parsing issues can occur with queries.

Add a link to the doc Using influx - InfluxDB command line interface

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the “influx - InfluxDB command line interface” documentation linked in the issue and compare it with the “Launch influx” section in the shell documentation. Add a link explaining how to launch and access the CLI, then verify that the rendered documentation points readers to the correct instructions.

Written by the indexing model from the issue text.

Assessment

Domain
cli, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.