resq_cli/lib.rs
1/*
2 * Copyright 2026 ResQ
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#![allow(clippy::pedantic)]
18
19//! `ResQ` CLI - Command-line interface for managing `ResQ` services.
20//!
21//! This crate provides a unified CLI for interacting with the `ResQ` platform,
22//! including service management, blockchain queries, and deployment operations.
23//!
24//! # Commands
25//!
26//! Grouped:
27//! - `scan audit` — run cargo/bun/uv audit across the workspace
28//! - `scan secrets` — scan for leaked credentials
29//! - `scan copyright` — check or apply license headers
30//! - `tui explore` / `logs` / `health` / `deploy` / `clean` / `asm` — TUI explorers
31//!
32//! Top-level:
33//! - `format` — format Rust / TS / Python / C++ / C# in one pass
34//! - `pre-commit` — full pre-commit gate (copyright, secrets, audit, format)
35//! - `hooks` — inspect / update installed git hooks
36//! - `dev` — repository utilities (workspace ops)
37//! - `version` / `docs` / `commit` — release + docs + AI commit messages
38//! - `completions` — emit shell completions for bash/zsh/fish/elvish/powershell
39//!
40//! Legacy flat forms (`resq audit`, `resq explore`, etc.) remain as hidden
41//! aliases for one release cycle.
42//!
43//! # Usage
44//!
45//! ```bash
46//! resq scan audit
47//! resq format --check
48//! resq pre-commit
49//! resq tui health
50//! resq completions bash > /usr/local/share/bash-completion/completions/resq
51//! ```
52
53#![deny(missing_docs)]
54
55/// CLI command implementations.
56pub mod commands;
57/// Gitignore pattern utilities.
58pub mod gitignore;
59/// Shared utility functions.
60pub mod utils;