Skip to content
This repository was archived by the owner on Dec 15, 2023. It is now read-only.

Commit 337426f

Browse files
committed
fix: ci and docs
1 parent 60d363d commit 337426f

File tree

6 files changed

+53
-33
lines changed

6 files changed

+53
-33
lines changed

.github/workflows/test_install_linux.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@ jobs:
1717
- uses: actions/checkout@v2
1818
- name: test install script
1919
run: |
20-
curl -s https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | sh
21-
curl -s https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | sh
20+
curl -s https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | bash -ex
21+
curl -s https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | bash -ex

.github/workflows/test_install_mac.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@ jobs:
1717
- uses: actions/checkout@v2
1818
- name: test install script
1919
run: |
20-
curl -s https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | sh
21-
curl -s https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | sh
20+
curl -s https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | bash -ex
21+
curl -s https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | bash -ex

.github/workflows/test_install_win.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@ jobs:
1717
- uses: actions/checkout@v2
1818
- name: test install script
1919
run: |
20-
curl -s https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | sh
21-
curl -s https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | sh
20+
curl -s https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | bash -ex
21+
curl -s https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | bash -ex

README.md

+23-13
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,27 @@
55
<h1>iotdb-cli</h1>
66
<h3>Apache IotDB CLI Client written in Rust</h3>
77

8-
[![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square&color=%23E5531A)](https://github.com/francis-du/iotdb-cli/blob/main/LICENSE)
8+
[![Contribute](https://img.shields.io/badge/contribute-now-a94064?color=%23E5531A&)](https://gitpod.io/#https://github.com/francis-du/iotdb-cli)
9+
[![downloads](https://img.shields.io/crates/d/iotdb-cli?style=flat-square&color=%23E5531A)](https://crates.io/crates/iotdb-cli)
10+
[![GitHub Release](https://img.shields.io/github/v/release/francis-du/iotdb-cli?include_prereleases&sort=semver&color=%23E5531A&style=flat-square)](https://github.com/francis-du/iotdb-cli/releases)
11+
![Top Lang](https://img.shields.io/github/languages/top/trisasnava/koifish?color=%23E5531A&style=flat-square)
912
[![Rust Build](https://img.shields.io/github/workflow/status/francis-du/iotdb-cli/cargo-test?label=build&style=flat-square)](https://github.com/francis-du/iotdb-cli/actions?query=workflow%3Acargo-test)
13+
[![Docs Build](https://img.shields.io/github/workflow/status/francis-du/iotdb-cli/mdbook-deploy?label=docs%20build&style=flat-square)](https://github.com/francis-du/iotdb-cli/actions?query=workflow:mdbook-deploy)
14+
[![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square&color=%23E5531A)](https://github.com/francis-du/iotdb-cli/blob/main/LICENSE)
1015
[![Crates Publish](https://img.shields.io/github/workflow/status/francis-du/iotdb-cli/cargo-publish?label=publish&style=flat-square)](https://github.com/francis-du/iotdb-cli/actions?query=workflow%3Acargo-publish)
1116

1217
</div>
1318

1419
---
1520

16-
![Alt](https://repobeats.axiom.co/api/embed/86055cf67fcaac9e6e93c64c9a7a1630686ceda1.svg "Repobeats analytics image")
21+
[![Alt](https://repobeats.axiom.co/api/embed/86055cf67fcaac9e6e93c64c9a7a1630686ceda1.svg "Repobeats analytics image")](https://github.com/francis-du/iotdb-cli/pulse)
1722

1823
## Installation
1924

25+
[![Linux supported](https://img.shields.io/badge/Linux%20x86__64-supported%20✓-228B22?style=flat-square&logo=linux)](https://github.com/francis-du/iotdb-cli/releases/latest)
26+
[![macOS supported](https://img.shields.io/badge/macOS%20x86__64-supported%20✓-228B22?style=flat-square&logo=apple)](https://github.com/francis-du/iotdb-cli/releases/latest)
27+
[![Windows supported](https://img.shields.io/badge/Windows%20x86__64-supported%20✓-228B22?style=flat-square&logo=windows)](https://github.com/francis-du/iotdb-cli/releases/latest)
28+
2029
1. Using `Cargo`
2130

2231
```shell
@@ -28,15 +37,15 @@ cargo install -f --git https://github.com/francis-du/iotdb-cli.git
2837
2. From [binary](https://github.com/francis-du/iotdb-cli/releases/latest)
2938

3039
```shell
31-
curl -s https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | sh
40+
curl -s https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | bash
3241

33-
curl -s https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | sh -s -- x.x.x
42+
curl -s https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | bash -s -- x.x.x
3443
```
3544

3645
```shell
37-
wget -qO- https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | sh
46+
wget -qO- https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | bash
3847

39-
wget -qO- https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | sh -s -- x.x.x
48+
wget -qO- https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | bash -s -- x.x.x
4049
```
4150

4251
## Usage
@@ -46,15 +55,14 @@ iotdb -h
4655
```
4756

4857
```shell
49-
5058
▀██▀ ▄▄█▀▀██ █▀▀██▀▀█ ▀██▀▀█▄ ▀██▀▀█▄
5159
██ ▄█▀ ██ ██ ██ ██ ██ ██
5260
██ ██ ██ ██ ██ ██ ██▀▀▀█▄
5361
██ ▀█▄ ██ ██ ██ ██ ██ ██
5462
▄██▄ ▀▀█▄▄▄█▀ ▄██▄ ▄██▄▄▄█▀ ▄██▄▄▄█▀
5563

5664
Author: github.com/francis-du <[email protected]>
57-
Version: iotdb-cli 0.0.2
65+
Version: iotdb-cli 0.0.3-alpha
5866

5967
USAGE:
6068
iotdb [FLAGS] [OPTIONS] [sql] [SUBCOMMAND]
@@ -77,11 +85,13 @@ ARGS:
7785
<sql> Execute single sql, eg: `iotdb "show storage group"`
7886

7987
SUBCOMMANDS:
80-
file Execute batch form sql file, eg: `iotdb file ddl.sql`
81-
help Prints this message or the help of the given subcommand(s)
82-
update Update binary(TODO)
83-
usage Print usage info
84-
88+
csv Csv util(TODO)
89+
file Execute batch form sql file, eg: `iotdb file ddl.sql`
90+
help Prints this message or the help of the given subcommand(s)
91+
load Load TsFile util(TODO)
92+
update Update binary(TODO)
93+
usage Print usage info
94+
version Prints version information
8595
```
8696

8797
1. Connect to IoTDB server

docs/src/get-started.md

+23-13
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,27 @@
55
<h1>iotdb-cli</h1>
66
<h3>Apache IotDB CLI Client written in Rust</h3>
77

8-
[![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square&color=%23E5531A)](https://github.com/francis-du/iotdb-cli/blob/main/LICENSE)
8+
[![Contribute](https://img.shields.io/badge/contribute-now-a94064?color=%23E5531A&)](https://gitpod.io/#https://github.com/francis-du/iotdb-cli)
9+
[![downloads](https://img.shields.io/crates/d/iotdb-cli?style=flat-square&color=%23E5531A)](https://crates.io/crates/iotdb-cli)
10+
[![GitHub Release](https://img.shields.io/github/v/release/francis-du/iotdb-cli?include_prereleases&sort=semver&color=%23E5531A&style=flat-square)](https://github.com/francis-du/iotdb-cli/releases)
11+
![Top Lang](https://img.shields.io/github/languages/top/trisasnava/koifish?color=%23E5531A&style=flat-square)
912
[![Rust Build](https://img.shields.io/github/workflow/status/francis-du/iotdb-cli/cargo-test?label=build&style=flat-square)](https://github.com/francis-du/iotdb-cli/actions?query=workflow%3Acargo-test)
13+
[![Docs Build](https://img.shields.io/github/workflow/status/francis-du/iotdb-cli/mdbook-deploy?label=docs%20build&style=flat-square)](https://github.com/francis-du/iotdb-cli/actions?query=workflow:mdbook-deploy)
14+
[![License](https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square&color=%23E5531A)](https://github.com/francis-du/iotdb-cli/blob/main/LICENSE)
1015
[![Crates Publish](https://img.shields.io/github/workflow/status/francis-du/iotdb-cli/cargo-publish?label=publish&style=flat-square)](https://github.com/francis-du/iotdb-cli/actions?query=workflow%3Acargo-publish)
1116

1217
</div>
1318

1419
---
1520

16-
![Alt](https://repobeats.axiom.co/api/embed/86055cf67fcaac9e6e93c64c9a7a1630686ceda1.svg "Repobeats analytics image")
21+
[![Alt](https://repobeats.axiom.co/api/embed/86055cf67fcaac9e6e93c64c9a7a1630686ceda1.svg "Repobeats analytics image")](https://github.com/francis-du/iotdb-cli/pulse)
1722

1823
## Installation
1924

25+
[![Linux supported](https://img.shields.io/badge/Linux%20x86__64-supported%20✓-228B22?style=flat-square&logo=linux)](https://github.com/francis-du/iotdb-cli/releases/latest)
26+
[![macOS supported](https://img.shields.io/badge/macOS%20x86__64-supported%20✓-228B22?style=flat-square&logo=apple)](https://github.com/francis-du/iotdb-cli/releases/latest)
27+
[![Windows supported](https://img.shields.io/badge/Windows%20x86__64-supported%20✓-228B22?style=flat-square&logo=windows)](https://github.com/francis-du/iotdb-cli/releases/latest)
28+
2029
1. Using `Cargo`
2130

2231
```shell
@@ -28,15 +37,15 @@ cargo install -f --git https://github.com/francis-du/iotdb-cli.git
2837
2. From [binary](https://github.com/francis-du/iotdb-cli/releases/latest)
2938

3039
```shell
31-
curl -s https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | sh
40+
curl -s https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | bash
3241

33-
curl -s https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | sh -s -- x.x.x
42+
curl -s https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | bash -s -- x.x.x
3443
```
3544

3645
```shell
37-
wget -qO- https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | sh
46+
wget -qO- https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | bash
3847

39-
wget -qO- https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | sh -s -- x.x.x
48+
wget -qO- https://raw.githubusercontent.com/francis-du/iotdb-cli/main/install.sh | bash -s -- x.x.x
4049
```
4150

4251
## Usage
@@ -46,15 +55,14 @@ iotdb -h
4655
```
4756

4857
```shell
49-
5058
▀██▀ ▄▄█▀▀██ █▀▀██▀▀█ ▀██▀▀█▄ ▀██▀▀█▄
5159
██ ▄█▀ ██ ██ ██ ██ ██ ██
5260
██ ██ ██ ██ ██ ██ ██▀▀▀█▄
5361
██ ▀█▄ ██ ██ ██ ██ ██ ██
5462
▄██▄ ▀▀█▄▄▄█▀ ▄██▄ ▄██▄▄▄█▀ ▄██▄▄▄█▀
5563

5664
Author: github.com/francis-du <[email protected]>
57-
Version: iotdb-cli 0.0.2
65+
Version: iotdb-cli 0.0.3-alpha
5866

5967
USAGE:
6068
iotdb [FLAGS] [OPTIONS] [sql] [SUBCOMMAND]
@@ -77,11 +85,13 @@ ARGS:
7785
<sql> Execute single sql, eg: `iotdb "show storage group"`
7886

7987
SUBCOMMANDS:
80-
file Execute batch form sql file, eg: `iotdb file ddl.sql`
81-
help Prints this message or the help of the given subcommand(s)
82-
update Update binary(TODO)
83-
usage Print usage info
84-
88+
csv Csv util(TODO)
89+
file Execute batch form sql file, eg: `iotdb file ddl.sql`
90+
help Prints this message or the help of the given subcommand(s)
91+
load Load TsFile util(TODO)
92+
update Update binary(TODO)
93+
usage Print usage info
94+
version Prints version information
8595
```
8696

8797
1. Connect to IoTDB server

install.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#!/bin/sh
1+
#!/bin/bash
22
# shellcheck disable=SC3003
33

44
NO_COLOR=$'\e[0m'

0 commit comments

Comments
 (0)