prustio 1.0.3

The Rust embedded project management.
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

//! Defines the main Command-Line Interface (CLI) structure.
//!
//! This module utilizes the `clap` crate to parse command-line arguments, 
//! flags, and subcommands. It acts as the entry point for user interaction, 
//! routing commands to the appropriate controllers.

use clap::{Parser, Subcommand};

pub mod device;
pub mod display;
pub mod project;

/// The root CLI parser for pRustIO.
#[derive(Parser)]
#[command(version)]
#[command(name = "PrustIO")]
#[command(about = "A project manager for Rust embedded projects.", long_about = None)]
pub struct Cli {
    /// The specific top-level command executed by the user.
    #[command(subcommand)]
    pub(crate) command: TopLevelCommands,
}

/// Represents the top-level subcommands available in the pRustIO CLI.
#[derive(Subcommand)]
pub enum TopLevelCommands {
    /// Lists all supported hardware boards and their specifications.
    Boards {
        filter: Option<String>,

        #[arg(long)]
        json_output: bool,
    },

    /// Manages connected hardware devices and serial monitoring.
    Device {
        #[command(subcommand)]
        command: device::DeviceCommands,
    },

    /// Manages pRustIO projects.
    Project {
        #[command(subcommand)]
        command: project::ProjectCommands,
    },
    
    /// Builds and/or uploads the project to a connected board.
    Run {
        #[arg(short, long)]
        target: Option<String>,
        #[arg(short, long)]
        environment: Option<String>,

        #[arg(long)]
        json_output: bool,
    },

    /// Switches the actively configured environment for the project.
    Activate {
        environment: String,

        #[arg(long)]
        json_output: bool,
    },

    /// Refreshes the project configuration based on the active environment.
    Refresh {
        #[arg(long)]
        json_output: bool,
    },

    /// Cleans the project by removing the `target/` and `.prio/` compilation directories.
    Clean {
        #[arg(long)]
        json_output: bool,
    },
}