codex-multi-workspace 0.3.3

Run Codex CLI in Docker across saved single-folder or multi-folder workspaces.
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

use std::path::PathBuf;

use clap::{Parser, Subcommand};

/// Launch and manage Codex CLI workspaces.
#[derive(Debug, Parser)]
#[command(name = "codex-ws", version, about)]
pub struct Cli {
    #[command(subcommand)]
    pub command: Command,
}

/// Commands supported by the `codex-ws` CLI.
#[derive(Debug, Subcommand)]
pub enum Command {
    /// Launch a Codex sandbox for a workspace manifest.
    Run(RunArgs),

    /// Read or update codex-ws user configuration.
    Config(ConfigArgs),

    /// Manage saved workspace manifests.
    Workspace(WorkspaceArgs),
}

/// Arguments used to launch a workspace sandbox.
#[derive(Debug, Parser)]
pub struct RunArgs {
    /// Provider configuration name to load from the local configuration database.
    #[arg(short, long)]
    pub provider: String,

    /// Workspace name or path to a workspace manifest YAML file.
    #[arg(short, long, value_name = "WORKSPACE")]
    pub workspace: PathBuf,

    /// Path to the local provider configuration database.
    #[arg(long, value_name = "PATH")]
    pub config_db: Option<PathBuf>,

    /// Host directory used to store per-workspace Codex sessions.
    #[arg(long, value_name = "PATH")]
    pub sessions_root: Option<PathBuf>,

    /// Docker image containing the Codex CLI.
    #[arg(long, value_name = "IMAGE")]
    pub image: Option<String>,
}

/// Arguments used to read or update user configuration.
#[derive(Debug, Parser)]
pub struct ConfigArgs {
    #[command(subcommand)]
    pub command: ConfigCommand,
}

/// User configuration commands.
#[derive(Debug, Subcommand)]
pub enum ConfigCommand {
    /// Read one config value, or all configured values when no name is provided.
    Get(ConfigGetArgs),

    /// Set a supported config value.
    Set(ConfigSetArgs),
}

/// Arguments used to read user configuration.
#[derive(Debug, Parser)]
pub struct ConfigGetArgs {
    /// Optional config name to read.
    pub config_name: Option<String>,
}

/// Arguments used to update user configuration.
#[derive(Debug, Parser)]
pub struct ConfigSetArgs {
    /// Supported config name.
    pub config_name: String,

    /// Config value to persist.
    pub config_value: PathBuf,
}

/// Arguments used to manage saved workspace manifests.
#[derive(Debug, Parser)]
pub struct WorkspaceArgs {
    #[command(subcommand)]
    pub command: WorkspaceCommand,
}

/// Workspace manifest management commands.
#[derive(Debug, Subcommand)]
pub enum WorkspaceCommand {
    /// List saved workspace manifests.
    Ls(WorkspaceLsArgs),

    /// Create or edit a saved workspace manifest.
    Add(WorkspaceAddArgs),
}

/// Arguments used to list saved workspace manifests.
#[derive(Debug, Parser)]
pub struct WorkspaceLsArgs {
    /// Host directory used to store codex-ws state and saved workspace manifests.
    #[arg(long, value_name = "PATH")]
    pub sessions_root: Option<PathBuf>,
}

/// Arguments used to add a saved workspace manifest.
#[derive(Debug, Parser)]
pub struct WorkspaceAddArgs {
    /// Workspace name used for the saved manifest file.
    pub workspace_name: String,

    /// Host directory used to store codex-ws state and saved workspace manifests.
    #[arg(long, value_name = "PATH")]
    pub sessions_root: Option<PathBuf>,
}