nautilus_cli/
lib.rs

1// -------------------------------------------------------------------------------------------------
2//  Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
3//  https://nautechsystems.io
4//
5//  Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
6//  You may not use this file except in compliance with the License.
7//  You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
8//
9//  Unless required by applicable law or agreed to in writing, software
10//  distributed under the License is distributed on an "AS IS" BASIS,
11//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12//  See the License for the specific language governing permissions and
13//  limitations under the License.
14// -------------------------------------------------------------------------------------------------
15
16//! Command-line interface and tools for [NautilusTrader](https://nautilustrader.io).
17//!
18//! The `nautilus-cli` crate provides a command-line interface for managing and
19//! operating NautilusTrader installations. It includes tools for database management,
20//! system configuration, and operational utilities:
21//!
22//! - Database initialization and management commands.
23//! - PostgreSQL schema setup and maintenance.
24//! - Configuration validation and setup utilities.
25//! - System administration and operational tools.
26//!
27//! # NautilusTrader
28//!
29//! [NautilusTrader](https://nautilustrader.io) is an open-source, production-grade, Rust-native
30//! engine for multi-asset, multi-venue trading systems.
31//!
32//! The system spans research, deterministic simulation, and live execution within a single
33//! event-driven architecture, providing research-to-live semantic parity.
34//!
35//! # Feature Flags
36//!
37//! This crate provides feature flags to control source code inclusion during compilation,
38//! depending on the intended use case:
39//!
40//! - `defi`: Enables blockchain/DeFi commands including block sync, DEX pool sync, and pool
41//!   analysis.
42
43#![warn(rustc::all)]
44#![warn(clippy::pedantic)]
45#![deny(unsafe_code)]
46#![deny(unsafe_op_in_unsafe_fn)]
47#![deny(nonstandard_style)]
48#![deny(missing_debug_implementations)]
49#![deny(clippy::missing_errors_doc)]
50#![deny(clippy::missing_panics_doc)]
51#![deny(rustdoc::broken_intra_doc_links)]
52#![allow(
53    clippy::assert_is_empty,
54    reason = "`assert!(x.is_empty())` is clearer than comparing against an empty value"
55)]
56
57#[cfg(feature = "defi")]
58mod blockchain;
59mod database;
60pub mod opt;
61
62use nautilus_persistence::backend::parquet::migration::{
63    ParquetMigrationConfig, migrate_parquet_catalog,
64};
65
66#[cfg(feature = "defi")]
67use crate::blockchain::run_blockchain_command;
68use crate::{
69    database::postgres::run_database_command,
70    opt::{CatalogCommand, Commands, NautilusCli},
71};
72
73/// Builds the top-level CLI command, augmented with capability-aware blockchain help.
74///
75/// The blockchain subcommands gain `after_long_help` sections derived from the adapter's DEX
76/// registration maps when the `defi` feature is enabled.
77#[must_use]
78pub fn cli_command() -> clap::Command {
79    let command = <NautilusCli as clap::CommandFactory>::command();
80    #[cfg(feature = "defi")]
81    let command = crate::blockchain::augment_blockchain_help(command);
82    command
83}
84
85/// Runs the Nautilus CLI based on the provided options.
86///
87/// # Errors
88///
89/// Returns an error if execution of the specified command fails.
90pub async fn run(opt: NautilusCli) -> anyhow::Result<()> {
91    match opt.command {
92        Commands::Catalog(catalog) => match catalog.command {
93            CatalogCommand::MigrateParquet(args) => {
94                let report = migrate_parquet_catalog(ParquetMigrationConfig {
95                    source_uri: args.source,
96                    target_uri: args.destination,
97                    source_options: args.source_options,
98                    target_options: args.target_options,
99                    dry_run: args.dry_run,
100                })?;
101                println!("{report}");
102            }
103        },
104        Commands::Database(database_opt) => run_database_command(database_opt).await?,
105        #[cfg(feature = "defi")]
106        Commands::Blockchain(blockchain_opt) => {
107            Box::pin(run_blockchain_command(blockchain_opt)).await?;
108        }
109    }
110    Ok(())
111}
nautilus_cli/lib.rs

nautilus_cli/
lib.rs
