nautilus_cli/lib.rs
1// -------------------------------------------------------------------------------------------------
2// Copyright (C) 2015-2025 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](http://nautilustrader.io).
17//!
18//! The `nautilus-cli` crate provides a comprehensive 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//! # Platform
28//!
29//! [NautilusTrader](http://nautilustrader.io) is an open-source, high-performance, production-grade
30//! algorithmic trading platform, providing quantitative traders with the ability to backtest
31//! portfolios of automated trading strategies on historical data with an event-driven engine,
32//! and also deploy those same strategies live, with no code changes.
33//!
34//! NautilusTrader's design, architecture, and implementation philosophy prioritizes software correctness and safety at the
35//! highest level, with the aim of supporting mission-critical, trading system backtesting and live deployment workloads.
36//!
37//! # Feature flags
38//!
39//! This crate provides feature flags to control source code inclusion during compilation,
40//! depending on the intended use case:
41//!
42//! - `hypersync`: Enables Hypersync blockchain functionality for high-performance blockchain data access.
43
44#![warn(rustc::all)]
45#![deny(unsafe_code)]
46#![deny(nonstandard_style)]
47#![deny(missing_debug_implementations)]
48#![deny(clippy::missing_errors_doc)]
49#![deny(clippy::missing_panics_doc)]
50#![deny(rustdoc::broken_intra_doc_links)]
51
52#[cfg(feature = "hypersync")]
53mod blockchain;
54mod database;
55pub mod opt;
56
57#[cfg(feature = "hypersync")]
58use crate::blockchain::run_blockchain_command;
59use crate::{
60 database::postgres::run_database_command,
61 opt::{Commands, NautilusCli},
62};
63
64/// Runs the Nautilus CLI based on the provided options.
65///
66/// # Errors
67///
68/// Returns an error if execution of the specified command fails.
69pub async fn run(opt: NautilusCli) -> anyhow::Result<()> {
70 match opt.command {
71 Commands::Database(database_opt) => run_database_command(database_opt).await?,
72 #[cfg(feature = "hypersync")]
73 Commands::Blockchain(blockchain_opt) => run_blockchain_command(blockchain_opt).await?,
74 }
75 Ok(())
76}