igniscope 0.1.0

Deterministic CLI analyzer for Ignition project exports and gateway backups.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

<!-- markdownlint-disable MD033 -->
<!-- markdownlint-disable MD041 -->
<div align="center">

<h4>A CLI tool that parses Ignition project exports and gateway backups.</h4>

<a href="https://github.com/marcelo-6/igniscope/relseases"><img src="https://img.shields.io/github/v/release/marcelo-6/igniscope?logo=github" alt="GitHub Release"></a>
<a href="https://crates.io/crates/igniscope/"><img src="https://img.shields.io/crates/v/igniscope?logo=Rust" alt="Crate Release"></a>
<a href="https://codecov.io/gh/marcelo-6/igniscope"><img src="https://codecov.io/gh/marcelo-6/igniscope/graph/badge.svg?token=TPJMXTJ5ZQ&amp;logo=Codecov&amp;logoColor=white" alt="Coverage"></a>
<br>
<a href="https://github.com/marcelo-6/igniscope/actions?query=workflow%3A%22CI%22"><img src="https://img.shields.io/github/actions/workflow/status/marcelo-6/igniscope/ci.yml?branch=main&amp;logo=GitHub%20Actions&amp;logoColor=white&amp;label=CI" alt="Continuous Integration"></a>
<a href="https://github.com/marcelo-6/igniscope/actions?query=workflow%3A%22CD%22"><img src="https://img.shields.io/github/actions/workflow/status/marcelo-6/igniscope/cd.yml?logo=GitHub%20Actions&amp;logoColor=white&amp;label=CD" alt="Continuous Deployment"></a>
<a href="https://docs.rs/igniscope/"><img src="https://img.shields.io/docsrs/igniscope?logo=Rust&amp;logoColor=white" alt="Documentation"></a>

</div>

## Features

- Deterministic zip archive parsing for project exports (`.zip`) and gateway backups (`.gwbk`)
- Clear, typed error handling with stable exit codes

## Installation

From crates.io:

```bash
cargo install igniscope
```

From source, clone the repo then:

```bash
cargo install --path .
```


## How To Use

Print a summary:

```bash
igniscope summarize ./path/to/archive.zip
```

Print a more verbose summary:

```bash
igniscope -v summarize ./path/to/archive.gwbk
```

Generate analysis artifacts:

```bash
igniscope analyze ./path/to/archive.gwbk --out-dir ./out
```

Expected outputs in `--out-dir`:

- `analytics.json`
- `report.md`

## Project Goals

- Port over my code from python into my first Rust project
- Keep parsing and outputs deterministic so results are reproducible
- Dependency edges (view/script/query linking).
- AST-based script analysis.

## Roadmap

- See [ROADMAP.md](ROADMAP.md) for the evolving idea log with tentative version targets.