You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- 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
**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.
135
110
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
137
118
138
-
### Interactive Terminal Mode
119
+
### Configuration
139
120
140
-
Menu-driven interfaces for guided terminal workflows:
121
+
FsPulse is configured through environment variables or a config file:
141
122
142
123
```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
145
128
```
146
129
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.
148
131
149
132
---
150
133
151
-
### 🖥️ Web Interface Highlights
134
+
### 🖥️ Interface Highlights
152
135
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:
154
137
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
156
139
-**Live Scan Progress** — Watch scan activity in real-time whether manually initiated or scheduled, with detailed phase-by-phase statistics
157
140
-**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
159
142
-**Alert Management** — Filter, flag, and dismiss integrity issues with context-aware views and status tracking
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).
4
4
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
+
```
6
20
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.
12
22
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
15
29
16
30
---
17
31
18
-
## Available Commands
32
+
## Configuration
19
33
20
-
### Data Analysis
34
+
FsPulse behavior is configured through **environment variables** or a **config file**, not command-line flags.
21
35
22
-
-**[query](cli/query.md)** — Execute SQL-inspired queries against scan data
0 commit comments