Skip to content

Commit 2677cce

Browse files
committed
Rename CLI tool from 'chel' to 'kelo' and update related documentation
1 parent 489f1ac commit 2677cce

File tree

5 files changed

+21
-21
lines changed

5 files changed

+21
-21
lines changed

.github/workflows/publish-report.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ jobs:
6262
- name: Generate ROS1 analysis JSON
6363
run: |
6464
cd moveit
65-
chel analyze --platform ros1 -f json -o ../analysis-ros1.json .
65+
kelo analyze --platform ros1 -f json -o ../analysis-ros1.json .
6666
6767
- name: Copy ROS1 analysis JSON into site output
6868
run: |
@@ -71,7 +71,7 @@ jobs:
7171
7272
- name: Generate ROS1 HTML report
7373
run: |
74-
chel report analysis-ros1.json -o report_output/ros1/ --config chelonian/docs/github_pages_report.toml
74+
kelo report analysis-ros1.json -o report_output/ros1/ --config chelonian/docs/github_pages_report.toml
7575
7676
- name: Checkout sample ROS2 workspace (moveit2)
7777
uses: actions/checkout@v4
@@ -83,7 +83,7 @@ jobs:
8383
- name: Generate ROS2 analysis JSON
8484
run: |
8585
cd moveit2
86-
chel analyze --platform ros2 -f json -o ../analysis-ros2.json .
86+
kelo analyze --platform ros2 -f json -o ../analysis-ros2.json .
8787
8888
- name: Copy ROS2 analysis JSON into site output
8989
run: |
@@ -92,7 +92,7 @@ jobs:
9292
9393
- name: Generate ROS2 HTML report
9494
run: |
95-
chel report analysis-ros2.json -o report_output/ros2/ --config chelonian/docs/github_pages_report_ros2.toml
95+
kelo report analysis-ros2.json -o report_output/ros2/ --config chelonian/docs/github_pages_report_ros2.toml
9696
9797
- name: Copy portal index.html
9898
run: |

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ keywords = ["ros", "ros2", "static-analysis", "migration", "robotics"]
1111
categories = ["development-tools", "command-line-utilities"]
1212

1313
[[bin]]
14-
name = "chel"
14+
name = "kelo"
1515
path = "src/main.rs"
1616

1717
[dependencies]

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,61 +19,61 @@ Install (from source):
1919
cargo install --path . --locked
2020
```
2121

22-
After installation use `chel` from your PATH.
22+
After installation use `kelo` from your PATH.
2323

2424
Analyze a workspace (text output):
2525

2626
```bash
27-
chel analyze /path/to/ros/workspace
27+
kelo analyze /path/to/ros/workspace
2828
```
2929

3030
Select a platform (load platform-specific builtin rules):
3131

3232
```bash
3333
# analyze with ROS1 builtin rules
34-
chel analyze --platform ros1 /path/to/ros/workspace
34+
kelo analyze --platform ros1 /path/to/ros/workspace
3535

3636
# analyze with ROS2 builtin rules
37-
chel analyze --platform ros2 /path/to/ros/workspace
37+
kelo analyze --platform ros2 /path/to/ros/workspace
3838
```
3939

4040
JSON output:
4141

4242
```bash
43-
chel analyze -f json /path/to/ros/workspace
43+
kelo analyze -f json /path/to/ros/workspace
4444
```
4545

4646
Custom rules:
4747

4848
```bash
4949
# add custom rules on top of builtin rules
50-
chel analyze --platform ros1 --rules /path/to/custom/rules /path/to/ros/workspace
50+
kelo analyze --platform ros1 --rules /path/to/custom/rules /path/to/ros/workspace
5151

5252
# load only custom rules (disable builtin)
53-
chel analyze --rules /path/to/custom/rules --no-builtin /path/to/ros/workspace
53+
kelo analyze --rules /path/to/custom/rules --no-builtin /path/to/ros/workspace
5454
```
5555

5656
List available rules:
5757

5858
```bash
59-
chel analyze --list-rules
59+
kelo analyze --list-rules
6060

6161
# include builtin rules for a specific platform
62-
chel analyze -p ros1 --list-rules
63-
chel analyze -p ros2 --list-rules
62+
kelo analyze -p ros1 --list-rules
63+
kelo analyze -p ros2 --list-rules
6464
```
6565

6666
Generate a static HTML report from JSON:
6767

6868
```bash
6969
# 1) analyze and write JSON to a file
70-
chel analyze -p ros1 -f json -o report.json /path/to/ros/workspace
70+
kelo analyze -p ros1 -f json -o report.json /path/to/ros/workspace
7171

7272
# 2) convert JSON to a standalone HTML file
73-
chel report report.json -o report.html
73+
kelo report report.json -o report.html
7474

7575
# or: write a directory bundle (index.html + assets/) for richer UI
76-
chel report report.json -o results/
76+
kelo report report.json -o results/
7777
```
7878

7979
Customize report sections (optional)
@@ -82,7 +82,7 @@ Customize report sections (optional)
8282
When writing a directory bundle (e.g. `-o results/`), you can customize the sidebar section ordering and visibility via a TOML config:
8383

8484
```bash
85-
chel report report.json -o results/ --config report.toml
85+
kelo report report.json -o results/ --config report.toml
8686
```
8787

8888
Example `report.toml`:

RULES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This document describes the TOML rule format used by Chelonian and the meaning o
66

77
Rules are declared in TOML files. Each file may contain multiple `[[rules]]` entries. The loader reads rules from:
88

9-
- The path provided with `chel analyze --rules` (file or directory),
9+
- The path provided with `kelo analyze --rules` (file or directory),
1010
- `~/.config/chelonian/rules/*.toml`,
1111
- Bundled built-in rules.
1212

src/commands/report.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ use crate::models::AnalysisReport;
1212

1313
#[derive(Args, Debug, Clone)]
1414
pub struct ReportArgs {
15-
/// Input analysis JSON file (produced by `chel analyze --format json`)
15+
/// Input analysis JSON file (produced by `kelo analyze --format json`)
1616
pub input: PathBuf,
1717

1818
/// Output path.

0 commit comments

Comments
 (0)