railwayapp 5.54.1

Interact with Railway via CLI
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

//! Check command-specific help through the same command builder used by the CLI.
use clap::error::ErrorKind;

fn help(args: &[&str], flag: &str) -> String {
    let error = crate::build_args()
        .try_get_matches_from(
            std::iter::once("railway")
                .chain(args.iter().copied())
                .chain(std::iter::once(flag)),
        )
        .unwrap_err();
    assert_eq!(error.kind(), ErrorKind::DisplayHelp);
    error
        .to_string()
        .split_whitespace()
        .collect::<Vec<_>>()
        .join(" ")
}

#[test]
fn launcher_help_matches_each_execution_path() {
    for flag in ["-h", "--help"] {
        let code = help(&["code"], flag);
        assert!(code.contains("railway code --codex connect my-box"));
        assert!(code.contains("--connection-json"));
        assert!(code.contains("command approvals disabled"));
        assert!(code.contains("An explicit agent flag creates a new VM"));
        for args in [vec!["ca"], vec!["ca", "start"]] {
            let text = help(&args, flag);
            assert!(!text.contains("railway code --codex connect"));
            assert!(!text.contains("--connection-json"));
            assert!(!text.contains("desktop-only"));
            assert!(!text.contains("--agent <NAME_OR_ID>"));
            assert!(text.contains("Arguments to pass to the agent after --"));
            assert!(text.contains("VM running"));
        }
    }
}

#[test]
fn focused_help_retains_side_effects_and_workflow_examples() {
    for (args, expected) in [
        (
            vec!["ca", "desktop"],
            vec![
                "--remove",
                "stops the managed OpenCode server",
                "VM stays running",
            ],
        ),
        (
            vec!["ca", "bootstrap"],
            vec!["bootstrap save dev", "saved on this machine"],
        ),
        (
            vec!["ca", "bootstrap", "default"],
            vec!["Name of a ready bootstrap", "does not change existing VMs"],
        ),
        (
            vec!["ca", "create"],
            vec![
                "--from-checkpoint <checkpoint-id>",
                "cloud-agent checkpoint ID",
            ],
        ),
        (
            vec!["ca", "ssh"],
            vec!["--session", "--resume", "Sleep ends its processes"],
        ),
        (
            vec!["code", "get-config"],
            vec![
                "without login or network access",
                "Snapshots include credentials",
            ],
        ),
        (
            vec!["sandbox", "create"],
            vec!["--private-network --domain 3000"],
        ),
        (
            vec!["sandbox", "fork"],
            vec!["are not inherited", "--domain web:3000"],
        ),
    ] {
        let text = help(&args, "--help");
        for expected in expected {
            assert!(text.contains(expected), "{args:?} missing {expected:?}");
        }
    }
}

#[test]
fn documented_examples_parse_without_executing_commands() {
    for args in [
        vec!["code", "--codex"],
        vec!["code", "--claude"],
        vec!["code", "--codex", "connect", "my-box"],
        vec!["code", "--codex", "desktop-only"],
        vec!["code", "get-config", "my-box"],
        vec!["ca", "start", "--codex", "--new"],
        // Help visibility must not remove previously accepted options.
        vec!["ca", "--codex", "--connection-json"],
        vec![
            "ca", "start", "--codex", "--agent", "my-box", "--dir", "/app",
        ],
        vec![
            "ca",
            "start",
            "--claude",
            "--",
            "exec",
            "explain this codebase",
        ],
        vec!["ca", "desktop", "--opencode", "--agent", "my-box"],
        vec![
            "ca",
            "bootstrap",
            "save",
            "dev",
            "--agent",
            "my-box",
            "--default",
        ],
        vec!["ca", "bootstrap", "default", "dev"],
        vec![
            "ca",
            "bootstrap",
            "default",
            "dev",
            "--environment",
            "staging",
        ],
        vec!["ca", "bootstrap", "list", "--environment", "staging"],
        vec!["ca", "bootstrap", "list", "--json"],
        vec![
            "ca",
            "bootstrap",
            "save",
            "dev",
            "--agent",
            "my-box",
            "--env-file",
            ".env",
            "--variable",
            "MODE=dev",
        ],
        vec!["code", "--codex", "--bootstrap", "dev"],
        vec![
            "ca",
            "create",
            "my-box",
            "--from-checkpoint",
            "checkpoint-id",
        ],
        vec!["ca", "ssh", "my-box", "--session"],
        vec!["ca", "ssh", "my-box", "--resume"],
        vec!["sandbox", "create", "--private-network", "--domain", "3000"],
        vec![
            "sandbox",
            "fork",
            "sandbox-id",
            "--private-network",
            "--domain",
            "web:3000",
        ],
        vec!["sandbox", "exec", "--detach", "--", "npm", "run", "build"],
        vec!["sandbox", "forward", "8080:3000"],
    ] {
        crate::build_args()
            .try_get_matches_from(std::iter::once("railway").chain(args.iter().copied()))
            .unwrap_or_else(|error| panic!("{args:?}: {error}"));
    }
}