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
//! # xbp Core Library
//!
//! **xbp** is a modular toolkit for deploying, building, and configuring modern projects (Rust, JS/Node, Next.js, etc.) with first-class support for extensibility, scripting, and cloud workflows.
//!
//! ---
//!
//! ## Features
//! - Modular and reusable core for CLI, scripts, and integrations
//! - Nginx-aware deployment (integrates config, reloads, etc.)
//! - Typed config management (YAML, SSH keys, secrets)
//! - Strategy-based deploy for multiple ecosystems and languages
//! - Async-structured logging throughout
//!
//! ---
//!
//! ## Architecture
//! - [`commands`] — CLI subcommands, as modular Rust functions/structs (deploy, ports, logs, ...)
//! - [`logging`] — Structured, async, and file-based logs (with per-command tracing)
//! - [`config`] — Load, write, and validate config (supports SSH, YAML, secrets)
//! - [`strategies`] — Project detection, deploy logic, and extensibility for new systems
//!
//! ---
//!
//! ## Quick Usage Example
//! ```rust
//! use xbp::commands::ports::list_ports;
//! let output = list_ports(None)?;
//! println!("{}", output);
//! ```
//!
//! ## CLI Example
//! ```bash
//! xbp ports # list all ports
//! xbp deploy # build & deploy current project (auto-detects)
//! ```
//!
//! ---
//!
//! ## Public APIs
//!
//! - All modules re-export their documented public items.
//! - Traits and extensibility points are found in each respective module.
//! - See each module for additional integration and usage patterns.
//!
//! ---
//!
//! ## Contributing
//! Keep all items generic, composable, and re-usable. Document new modules/functions. See README for contribution rules and style guidelines.