shardline 1.0.0

Self-hosted Shardline CAS server and operator CLI for Git/Xet storage workflows.
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

#![deny(unsafe_code)]
#![cfg_attr(
    test,
    allow(
        clippy::unwrap_used,
        clippy::expect_used,
        clippy::indexing_slicing,
        clippy::arithmetic_side_effects,
        clippy::shadow_unrelated,
        clippy::let_underscore_must_use,
        clippy::format_push_string
    )
)]

//! Library surface behind the `shardline` command-line entry point.
//!
//! The binary target is intentionally thin: it delegates parsing, artifact
//! generation, configuration loading, and operator workflows to this crate. That
//! keeps command behavior testable and lets integration tests exercise the same
//! code paths as the installed `shardline` executable.
//!
//! The most commonly embedded pieces are [`CliCommand`] for parsing, [`render_manpage`]
//! and [`render_completion`] for packaging artifacts, and [`run_providerless_setup`]
//! for bootstrapping a local host deployment.
//!
//! # Example
//!
//! ```
//! use shardline::{CliCommand, CompletionShell, render_completion};
//!
//! let command = CliCommand::parse(["shardline", "config", "check"])?;
//! assert!(matches!(command, CliCommand::ConfigCheck));
//!
//! let completion = render_completion(CompletionShell::Bash)?;
//! assert!(completion.contains("shardline"));
//! # Ok::<(), Box<dyn std::error::Error>>(())
//! ```

mod adapter;
mod admin;
mod artifact;
mod backup;
mod bench;
mod command;
mod config;
mod db;
mod fsck;
mod gc;
mod gc_schedule;
mod hold;
mod local_output;
mod local_path;
mod providerless;
mod rebuild;
mod repair;
pub mod report_output;
mod storage_migration;

pub use adapter::{CliRuntimeError, run_health_check};
pub use admin::{AdminTokenError, mint_admin_token, mint_admin_token_from_sources};
pub use artifact::{CliArtifactError, render_completion, render_manpage};
pub use backup::{BackupRuntimeError, run_backup_manifest};
pub use bench::{
    BenchConfig, BenchDeploymentTarget, BenchInventoryScope, BenchReport, BenchRuntimeError,
    BenchScenario, ByteMetrics, ChunkMetrics, IngestBenchReport, InventoryMetrics, LatencyMetrics,
    TimingMetrics, run_bench, run_ingest_bench,
};
pub use command::{BenchMode, CliCommand, CliParseError, CompletionShell, RedactedDbUrl};
pub use config::{
    ConfigRuntimeError, effective_root, load_server_config, run_config_check_from_env,
};
pub use db::{DbRuntimeError, run_db_migration};
pub use fsck::{FsckRuntimeError, run_fsck};
pub use gc::{GcRuntimeError, run_gc, run_gc_diagnostics};
pub use gc_schedule::{
    GcScheduleError, GcScheduleInstallOptions, GcScheduleInstallReport, GcScheduleUninstallReport,
    install_gc_schedule, uninstall_gc_schedule,
};
pub use hold::{
    HoldRuntimeError, print_hold_list_summary, print_hold_summary, run_hold_list, run_hold_release,
    run_hold_set,
};
pub use local_output::write_output_bytes;
pub use providerless::{
    ProviderlessRuntimeError, ProviderlessSetupReport, load_runtime_server_config,
    run_providerless_setup,
};
pub use rebuild::{RebuildRuntimeError, run_index_rebuild};
pub use repair::{RepairReport, RepairRuntimeError, run_lifecycle_repair, run_repair};
pub use storage_migration::{StorageMigrationRuntimeError, run_storage_migration};