Skip to content

Commit a172751

Browse files
committed
Update documentation for web-first architecture
- Remove CLI command docs (query, report, interact, explore) - now web-only - Simplify CLI docs to just launching the server (serve is now optional) - Rename sections to match UI: Interface, Monitor, Insights, Explore - Reorder Interface subsections to match actual UI navigation - Document new Access Denied alert type - Update Explore page to describe structured query tabs and Query tab - Add access, access_old, access_new columns to Query Syntax - Add schedule_id, size_old, size_new columns to Query Syntax - Reorder Query Syntax columns to match database schema - Fix code block annotations to pass mdbook test
1 parent 7833b49 commit a172751

File tree

20 files changed

+241
-583
lines changed

20 files changed

+241
-583
lines changed

README.md

Lines changed: 26 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Whether you're managing storage capacity, tracking project evolution, or ensurin
5656
- **Historical Analysis** — Interactive trend charts show how your data evolves: sizes, counts, changes, and alerts
5757
- **Alert System** — Suspicious hash changes and validation failures flagged immediately with status management
5858
- **Powerful Query Language** — SQL-inspired syntax for filtering, sorting, and analyzing your filesystem data
59-
- **Dual Interface** — Elegant web UI for visual exploration, full-featured CLI for automation and scripting
59+
- **Web-First Design** — Elegant web UI for all operations including scanning, browsing, querying, and configuration
6060

6161
---
6262

@@ -68,10 +68,9 @@ Quick start instructions are below, but full documentation is available in book
6868

6969
Key sections:
7070
- [Getting Started](https://gtunes-dev.github.io/fspulse/getting_started.html) — Installation, Docker deployment, and first steps
71-
- [Web Interface](https://gtunes-dev.github.io/fspulse/web_ui.html) — Complete guide to Monitor, Browse, Insights, Alerts, and Explore pages
71+
- [Interface](https://gtunes-dev.github.io/fspulse/web_ui.html) — Complete guide to Monitor, Browse, Insights, Alerts, and Explore pages
7272
- [Scanning Concepts](https://gtunes-dev.github.io/fspulse/scanning.html) — How scans work, hashing, and validation
7373
- [Query Syntax](https://gtunes-dev.github.io/fspulse/query.html) — Powerful filtering and data exploration
74-
- [Command-Line Interface](https://gtunes-dev.github.io/fspulse/cli.html) — CLI commands for automation and scripting
7574
- [Configuration](https://gtunes-dev.github.io/fspulse/configuration.html) — Customizing FsPulse behavior
7675

7776
---
@@ -93,69 +92,53 @@ The [Docker Deployment Guide](https://gtunes-dev.github.io/fspulse/docker.html)
9392

9493
---
9594

96-
## Usage Examples
95+
## Running FsPulse
9796

98-
FsPulse can run in three modes depending on your needs:
99-
100-
### Web UI Mode
101-
102-
Start the server and access through your browser:
97+
Start the FsPulse server:
10398

10499
```sh
105-
fspulse serve
100+
fspulse
106101
```
107102

108-
Open **http://127.0.0.1:8080** in your browser to access the full web interface.
109-
110-
**Great for:** Visual data exploration, managing multiple roots, real-time scan monitoring, continuous awareness
111-
112-
---
113-
114-
### Command-Line Mode
115-
116-
Direct terminal commands for scripting and automation:
103+
Or explicitly:
117104

118105
```sh
119-
# Query for invalid items
120-
fspulse query "items where val:(I)"
121-
122-
# View recent scans
123-
fspulse report scans --last 5
124-
125-
# Find items with hash changes
126-
fspulse query "changes where hash_change:(T) show item_path, hash_old, hash_new"
127-
128-
# Find directories over 10GB
129-
fspulse query "items where size > 10GB and item_type:(D)"
106+
fspulse serve
130107
```
131108

132-
**Great for:** Automation, scripted workflows, CI/CD integration, quick one-off operations
133-
134-
**Note:** All scanning is performed through the web UI. The CLI provides powerful querying and reporting capabilities.
109+
Open **http://127.0.0.1:8080** in your browser to access the web interface.
135110

136-
---
111+
All functionality is available through the web UI:
112+
- Configure and manage scan roots
113+
- Schedule automatic scans
114+
- Monitor scan progress in real-time
115+
- Browse your filesystem hierarchy
116+
- Query and explore your data
117+
- Manage alerts and validation issues
137118

138-
### Interactive Terminal Mode
119+
### Configuration
139120

140-
Menu-driven interfaces for guided terminal workflows:
121+
FsPulse is configured through environment variables or a config file:
141122

142123
```sh
143-
fspulse interact # Menu-driven interface
144-
fspulse explore # Full-screen data explorer
124+
# Example: Change port and enable debug logging
125+
export FSPULSE_SERVER_PORT=9090
126+
export FSPULSE_LOGGING_FSPULSE=debug
127+
fspulse
145128
```
146129

147-
**Great for:** Terminal users who want visual feedback without leaving the command line
130+
See the [Configuration Guide](https://gtunes-dev.github.io/fspulse/configuration.html) for all available settings.
148131

149132
---
150133

151-
### 🖥️ Web Interface Highlights
134+
### 🖥️ Interface Highlights
152135

153-
The web UI provides powerful visual tools for monitoring and exploring your data:
136+
The interface provides powerful visual tools for monitoring and exploring your data:
154137

155-
- **Monitor & Schedule** — Configure automatic scans with flexible scheduling options, view execution queue status, and manage scan roots
138+
- **Monitor** — Configure automatic scans with flexible scheduling options, view execution queue status, and manage scan roots
156139
- **Live Scan Progress** — Watch scan activity in real-time whether manually initiated or scheduled, with detailed phase-by-phase statistics
157140
- **Browse with Detail View** — Explore your filesystem hierarchy with elegant sliding panels showing item metadata, validation status, alerts, and complete change history
158-
- **Insights & Trends** — Interactive charts tracking file sizes, counts, change activity, and validation issues over time with customizable date ranges
141+
- **Insights** — Interactive charts tracking file sizes, counts, change activity, and validation issues over time with customizable date ranges
159142
- **Alert Management** — Filter, flag, and dismiss integrity issues with context-aware views and status tracking
160143

161144
<p align="center">

docs/book.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
[book]
22
authors = ["gtunes-dev"]
33
language = "en"
4-
multilingual = false
54
src = "src"
65
title = "FsPulse"

docs/src/SUMMARY.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,14 @@
77
- [Docker Deployment](docker.md)
88
- [First Steps](getting_started/first_steps.md)
99
- [Scanning Concepts](scanning.md)
10-
- [Web Interface](web_ui.md)
10+
- [Interface](web_ui.md)
1111
- [Scans](web_ui/scans.md)
12-
- [Monitor & Scheduling](web_ui/monitor.md)
12+
- [Monitor](web_ui/monitor.md)
1313
- [Browse](web_ui/browse.md)
14-
- [Insights & Trends](web_ui/insights.md)
1514
- [Alerts](web_ui/alerts.md)
16-
- [Explore (Query Interface)](web_ui/explore.md)
15+
- [Insights](web_ui/insights.md)
16+
- [Explore](web_ui/explore.md)
1717
- [Command-Line Interface](cli.md)
18-
- [Query Command](cli/query.md)
19-
- [Report Commands](cli/reports.md)
20-
- [Interactive Mode](interactive_mode.md)
2118
- [Query Syntax](query.md)
2219
- [Configuration](configuration.md)
2320
- [Validators](validators.md)

docs/src/cli.md

Lines changed: 54 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,83 @@
11
# Command-Line Interface
22

3-
FsPulse is designed with the web UI as the primary interface for all users. However, the CLI provides powerful capabilities for expert users who prefer terminal workflows, automation, and scripting integration.
3+
FsPulse is a **web-first application**. The CLI exists solely to launch the web server—all functionality including scanning, querying, browsing, and configuration is accessed through the [Interface](web_ui.md).
44

5-
## CLI Purpose and Limitations
5+
---
6+
7+
## Starting FsPulse
8+
9+
To start the FsPulse server:
10+
11+
```sh
12+
fspulse
13+
```
14+
15+
Or explicitly:
16+
17+
```sh
18+
fspulse serve
19+
```
620

7-
**What the CLI Provides:**
8-
- Query and analyze scan data
9-
- Generate formatted reports
10-
- Automate data analysis workflows
11-
- Integrate with scripts, cron jobs, and CI/CD pipelines
21+
Both commands are equivalent. The server starts on `http://127.0.0.1:8080` by default.
1222

13-
**Important Limitation:**
14-
All **scanning operations** must be performed through the web UI. Start the server with `fspulse serve` and use the [Web Interface](web_ui.md) to configure and run scans. The CLI provides access to query and analyze data generated by scans, but cannot initiate scans.
23+
Once running, open your browser to access the full web interface for:
24+
- Managing scan roots and schedules
25+
- Running and monitoring scans
26+
- Browsing your filesystem data
27+
- Querying and exploring results
28+
- Managing alerts
1529

1630
---
1731

18-
## Available Commands
32+
## Configuration
1933

20-
### Data Analysis
34+
FsPulse behavior is configured through **environment variables** or a **config file**, not command-line flags.
2135

22-
- **[query](cli/query.md)** — Execute SQL-inspired queries against scan data
23-
- **[report](cli/reports.md)** — Generate prebuilt formatted reports
36+
### Environment Variables
2437

25-
### Interactive Interfaces
38+
Set these before running `fspulse`:
2639

27-
- **[interact / explore](interactive_mode.md)** — Menu-driven and full-screen TUI interfaces for terminal users
40+
```sh
41+
# Server settings
42+
export FSPULSE_SERVER_HOST=0.0.0.0 # Bind address (default: 127.0.0.1)
43+
export FSPULSE_SERVER_PORT=9090 # Port number (default: 8080)
44+
45+
# Analysis settings
46+
export FSPULSE_ANALYSIS_THREADS=16 # Worker threads (default: 8)
47+
48+
# Logging
49+
export FSPULSE_LOGGING_FSPULSE=debug # Log level (default: info)
2850

29-
### Server
51+
# Data location
52+
export FSPULSE_DATA_DIR=/custom/path # Data directory override
53+
54+
fspulse
55+
```
3056

31-
- **serve** — Start the FsPulse web service (default: `http://127.0.0.1:8080`)
57+
### Configuration File
58+
59+
FsPulse also reads from `config.toml` in the data directory. See [Configuration](configuration.md) for complete documentation including:
60+
- All available settings
61+
- Environment variable reference
62+
- Platform-specific data directory locations
63+
- Docker configuration
3264

3365
---
3466

3567
## Getting Help
3668

37-
View available commands and options:
69+
View version and basic usage:
3870

3971
```sh
4072
fspulse --help
41-
fspulse <command> --help
42-
```
43-
44-
Examples:
45-
```sh
46-
fspulse query --help
47-
fspulse report scans --help
73+
fspulse --version
4874
```
4975

5076
---
5177

5278
## Related Documentation
5379

54-
- **[Query Syntax](query.md)** — Learn the query language used by the `query` command
55-
- **[Configuration](configuration.md)** — Configure database location, server settings, and more
56-
- **[Web Interface](web_ui.md)** — Primary interface for all users including scan management
57-
- **[Docker Deployment](docker.md)** — Using CLI commands in Docker containers
80+
- **[Configuration](configuration.md)** — Complete configuration reference
81+
- **[Interface](web_ui.md)** — Guide to all UI features
82+
- **[Docker Deployment](docker.md)** — Running FsPulse in Docker
5883

docs/src/cli/query.md

Lines changed: 0 additions & 108 deletions
This file was deleted.

0 commit comments

Comments
 (0)