Skip to content

Commit b8d39a1

Browse files
committed
refactor(cli)!: rename binary
1 parent 6b33a37 commit b8d39a1

File tree

6 files changed

+21
-15
lines changed

6 files changed

+21
-15
lines changed

cli/Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ assert_cmd = "2"
4545
tokio-test = "0.4"
4646

4747
[[bin]]
48-
name = "stac"
48+
name = "stacrs"
4949
path = "src/main.rs"
5050
doc = false
5151
test = false

cli/README.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
![Crates.io](https://img.shields.io/crates/l/stac-cli?style=for-the-badge)
77
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg?style=for-the-badge)](./CODE_OF_CONDUCT)
88

9-
Command Line Interface (CLI) for [STAC](https://stacspec.org/) built with [stac-rs](https://github.com/stac-utils/stac-rs).
9+
Command Line Interface (CLI), named `stacrs` for [STAC](https://stacspec.org/) built with [stac-rs](https://github.com/stac-utils/stac-rs).
1010

1111
![stac-cli gif](./img/stac-cli.gif)
1212

@@ -19,6 +19,12 @@ Then:
1919
cargo install stac-cli
2020
```
2121

22+
You can also install it from PyPI, where it is named **stacrs**:
23+
24+
```shell
25+
pip install stacrs
26+
```
27+
2228
### Homebrew
2329

2430
If you use [homebrew](https://brew.sh/), you can use [gadomski's](https://github.com/gadomski/) tap to install:
@@ -29,14 +35,14 @@ brew install gadomski/gadomski/stac
2935

3036
## Usage
3137

32-
**stac-cli** provides the following subcommands:
38+
**stacrs** provides the following subcommands:
3339

34-
- `stac item`: create STAC items and combine them into item collections
35-
- `stac search`: search STAC APIs
36-
- `stac serve`: serve a STAC API
37-
- `stac sort`: sort the fields of STAC items, catalogs, and collections
38-
- `stac translate`: convert STAC values from one format to another
39-
- `stac validate`: validate STAC items, catalogs, and collections using [json-schema](https://json-schema.org/)
40+
- `stacrs item`: create STAC items and combine them into item collections
41+
- `stacrs search`: search STAC APIs
42+
- `stacrs serve`: serve a STAC API
43+
- `stacrs sort`: sort the fields of STAC items, catalogs, and collections
44+
- `stacrs translate`: convert STAC values from one format to another
45+
- `stacrs validate`: validate STAC items, catalogs, and collections using [json-schema](https://json-schema.org/)
4046

4147
Use the `--help` flag to see all available options for the CLI and the subcommands:
4248

cli/tests/help.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@ use assert_cmd::Command;
22

33
#[test]
44
fn help() {
5-
let mut command = Command::cargo_bin("stac").unwrap();
5+
let mut command = Command::cargo_bin("stacrs").unwrap();
66
command.arg("help").assert().success();
77
}

cli/tests/item.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ use stac::{Item, ItemCollection};
33

44
#[test]
55
fn item() {
6-
let mut command = Command::cargo_bin("stac").unwrap();
6+
let mut command = Command::cargo_bin("stacrs").unwrap();
77
command.arg("item").arg("an-id").assert().success();
88
}
99

1010
#[test]
1111
fn item_collection() {
12-
let mut command = Command::cargo_bin("stac").unwrap();
12+
let mut command = Command::cargo_bin("stacrs").unwrap();
1313
let item_a = serde_json::to_string(&Item::new("item-a")).unwrap();
1414
let output = command
1515
.arg("item")

cli/tests/sort.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ use std::{fs::File, io::Read};
33

44
#[test]
55
fn sort_stdin() {
6-
let mut command = Command::cargo_bin("stac").unwrap();
6+
let mut command = Command::cargo_bin("stacrs").unwrap();
77
let mut item = String::new();
88
File::open("examples/simple-item.json")
99
.unwrap()

cli/tests/validate.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ use std::{fs::File, io::Read};
33

44
#[test]
55
fn validate() {
6-
let mut command = Command::cargo_bin("stac").unwrap();
6+
let mut command = Command::cargo_bin("stacrs").unwrap();
77
command
88
.arg("validate")
99
.arg("examples/simple-item.json")
@@ -13,7 +13,7 @@ fn validate() {
1313

1414
#[test]
1515
fn validate_stdin() {
16-
let mut command = Command::cargo_bin("stac").unwrap();
16+
let mut command = Command::cargo_bin("stacrs").unwrap();
1717
let mut item = String::new();
1818
File::open("examples/simple-item.json")
1919
.unwrap()

0 commit comments

Comments
 (0)