fix: add -s --service to sysg logs

ra0x3 · ra0x3 · commit 94692bb2ee63 · 2026-02-12T09:21:57.000-08:00
diff --git a/README.md b/README.md
@@ -293,13 +293,13 @@ $ sysg inspect myservice --no-color
 $ sysg logs
 
 # View logs for a specific service
-$ sysg logs api-service
+$ sysg logs --service api-service
 
 # View a custom number of log lines
-$ sysg logs database --lines 100
+$ sysg logs --service database --lines 100
 
 # View specific log type (stdout, stderr, or supervisor)
-$ sysg logs myservice --kind stderr
+$ sysg logs --service myservice --kind stderr
 ```
 
 **Spawn** - Dynamically spawn child processes from parent services:
diff --git a/docs/docs/examples/crud.md b/docs/docs/examples/crud.md
@@ -154,7 +154,7 @@ sysg restart node__web_server
 ### View logs
 
 ```bash
-sysg logs node__web_server --follow
+sysg logs --service node__web_server
 ```
 
 ### Manual backup
@@ -183,10 +183,10 @@ sysg cron list
 ## Monitoring
 
 ```bash
-sysg status                           # Service health
-sysg cron status                      # Cron job history
-sysg logs automated_testing           # Test results
-sysg logs database_backup             # Backup logs
+sysg status                                    # Service health
+sysg cron status                               # Cron job history
+sysg logs --service automated_testing          # Test results
+sysg logs --service database_backup            # Backup logs
 ```
 
 ## See also
diff --git a/docs/docs/examples/hello-world.md b/docs/docs/examples/hello-world.md
@@ -32,7 +32,7 @@ done
 
 ```bash
 sysg start
-sysg logs counter
+sysg logs --service counter
 sysg stop
 ```
 
diff --git a/docs/docs/examples/orchestrator.md b/docs/docs/examples/orchestrator.md
@@ -95,7 +95,7 @@ redis-server
 sysg start
 
 # Monitor
-sysg logs orchestrator -f
+sysg logs --service orchestrator
 redis-cli KEYS "*"
 
 # Control
diff --git a/docs/docs/how-it-works/commands/index.md b/docs/docs/how-it-works/commands/index.md
@@ -45,7 +45,7 @@ Most commands accept a service name:
 
 ```sh
 sysg restart --service api
-sysg logs worker
+sysg logs --service worker
 sysg stop --service redis
 ```
 
diff --git a/docs/docs/how-it-works/commands/inspect.md b/docs/docs/how-it-works/commands/inspect.md
@@ -15,7 +15,7 @@ sysg inspect myservice
 
 | Option | Description |
 |--------|------------|
-| `--window` | Time window to display (e.g., "5s" for live, "12h" for historical). Short durations (<=60s) enable live mode with auto-refresh (default: 5s) |
+| `--window` | Time window to display (e.g., "5s" for live, "12h" for historical). Short durations (&lt;=60s) enable live mode with auto-refresh (default: 5s) |
 | `--config` | Path to configuration file |
 | `--json` | Emit machine-readable JSON output instead of a report |
 | `--sys` | Opt into privileged system mode. Requires running as root |
diff --git a/docs/docs/how-it-works/commands/logs.md b/docs/docs/how-it-works/commands/logs.md
@@ -16,6 +16,7 @@ sysg logs
 | Option | Description |
 |--------|------------|
 | `--config` | Path to configuration file |
+| `--service` | The name of the service whose logs should be displayed (optional) |
 | `--lines` | Number of lines to show (default: 50) |
 | `--kind` | Kind of logs to show: stdout, stderr, or supervisor (default: stdout) |
 | `--sys` | Opt into privileged system mode. Requires running as root |
@@ -33,13 +34,13 @@ sysg logs
 ### View logs from specific service
 
 ```sh
-sysg logs api
+sysg logs --service api
 ```
 
 ### View stderr logs
 
 ```sh
-sysg logs --kind stderr api
+sysg logs --service api --kind stderr
 ```
 
 ### View supervisor logs
@@ -51,7 +52,7 @@ sysg logs --kind supervisor
 ### Show more history
 
 ```sh
-sysg logs --lines 200 api
+sysg logs --service api --lines 200
 ```
 
 ## Log files
diff --git a/docs/docs/quickstart.md b/docs/docs/quickstart.md
@@ -46,7 +46,7 @@ hello    running  42309  3s
 ## View logs
 
 ```bash
-sysg logs hello
+sysg logs --service hello
 ```
 
 ## Stop everything
diff --git a/examples/crud/README.md b/examples/crud/README.md
@@ -82,7 +82,7 @@ sysg status
 View logs for the web server:
 
 ```bash
-sysg logs node__web_server
+sysg logs --service node__web_server
 ```
 
 ### Stop Services
diff --git a/examples/hello-world/README.md b/examples/hello-world/README.md
@@ -60,7 +60,7 @@ sysg status
 
 ### View logs:
 ```bash
-sysg logs sh__hello_world
+sysg logs --service sh__hello_world
 ```
 
 ### Expected log output:
diff --git a/src/bin/main.rs b/src/bin/main.rs
@@ -326,7 +326,7 @@ fn main() -> Result<(), Box<dyn Error>> {
                             &service,
                             process_pid,
                             lines,
-                            kind.as_deref(),
+                            Some(kind.as_str()),
                         )?;
                     } else {
                         let cron_state = CronStateFile::load().unwrap_or_default();
@@ -340,7 +340,7 @@ fn main() -> Result<(), Box<dyn Error>> {
                             manager.show_inactive_log(
                                 &service,
                                 lines,
-                                kind.as_deref(),
+                                Some(kind.as_str()),
                             )?;
                         } else {
                             warn!("Service '{service}' is not currently running");
@@ -349,7 +349,11 @@ fn main() -> Result<(), Box<dyn Error>> {
                 }
                 None => {
                     info!("Fetching logs for all services");
-                    manager.show_logs(lines, kind.as_deref(), Some(&effective_config))?;
+                    manager.show_logs(
+                        lines,
+                        Some(kind.as_str()),
+                        Some(&effective_config),
+                    )?;
                 }
             }
         }
diff --git a/src/cli.rs b/src/cli.rs
@@ -1,5 +1,5 @@
 //! Command-line interface for Systemg.
-use std::str::FromStr;
+use std::{fmt, str::FromStr};
 
 use clap::{Parser, Subcommand};
 use tracing::level_filters::LevelFilter;
@@ -66,6 +66,51 @@ impl FromStr for LogLevelArg {
     }
 }
 
+/// Type of logs to display.
+#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
+pub enum LogKind {
+    /// Standard output logs
+    #[default]
+    Stdout,
+    /// Standard error logs
+    Stderr,
+    /// Supervisor logs
+    Supervisor,
+}
+
+impl LogKind {
+    /// String representation for file paths and display.
+    pub fn as_str(&self) -> &'static str {
+        match self {
+            LogKind::Stdout => "stdout",
+            LogKind::Stderr => "stderr",
+            LogKind::Supervisor => "supervisor",
+        }
+    }
+}
+
+impl fmt::Display for LogKind {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        write!(f, "{}", self.as_str())
+    }
+}
+
+impl FromStr for LogKind {
+    type Err = String;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        match s.trim().to_lowercase().as_str() {
+            "stdout" => Ok(LogKind::Stdout),
+            "stderr" => Ok(LogKind::Stderr),
+            "supervisor" => Ok(LogKind::Supervisor),
+            _ => Err(format!(
+                "invalid log kind '{}', must be one of: stdout, stderr, supervisor",
+                s
+            )),
+        }
+    }
+}
+
 /// Command-line interface for Systemg.
 #[derive(Parser)]
 #[command(name = "systemg", version, author)]
@@ -189,15 +234,16 @@ pub enum Commands {
         config: String,
 
         /// The name of the service whose logs should be displayed (optional).
+        #[arg(short, long)]
         service: Option<String>,
 
         /// Number of lines to show (default: 50).
         #[arg(short, long, default_value = "50")]
         lines: usize,
 
         /// Kind of logs to show: stdout, stderr, or supervisor (default: stdout).
-        #[arg(short = 'k', long, default_value = "stdout")]
-        kind: Option<String>,
+        #[arg(short = 'k', long, default_value_t = LogKind::default())]
+        kind: LogKind,
     },
 
     /// Purge all systemg state and runtime files.
diff --git a/tests/docker/kernel/run_kernel_tests.sh b/tests/docker/kernel/run_kernel_tests.sh
@@ -197,7 +197,7 @@ log_test "Scenario 3: System monitoring and troubleshooting"
 
 # Test log streaming
 log_info "Testing real-time log streaming..."
-timeout 5 sysg logs app_worker &
+timeout 5 sysg logs --service app_worker &
 LOGS_PID=$!
 sleep 2
 if kill -0 $LOGS_PID 2>/dev/null; then
@@ -221,7 +221,7 @@ fi
 
 # Test specific service logs
 log_info "Testing service-specific log retrieval..."
-if sysg logs nginx --lines 10 2>/dev/null | grep -q nginx; then
+if sysg logs --service nginx --lines 10 2>/dev/null | grep -q nginx; then
     log_success "Service-specific logs accessible"
 else
     log_info "Nginx logs may not be available yet"
diff --git a/tests/docker/user/run_user_tests.sh b/tests/docker/user/run_user_tests.sh
@@ -333,7 +333,7 @@ fi
 
 # Test service-specific debugging
 log_info "Debugging specific service..."
-timeout 5 sysg logs --config systemg.yaml worker &
+timeout 5 sysg logs --config systemg.yaml --service worker &
 LOG_PID=$!
 sleep 2
 kill $LOG_PID 2>/dev/null
diff --git a/tests/integration/logs.rs b/tests/integration/logs.rs
@@ -37,6 +37,7 @@ fn logs_streams_when_pid_has_no_fds() {
     let mut cmd = Command::new(assert_cmd::cargo::cargo_bin!("sysg"));
     cmd.env("SYSTEMG_TAIL_MODE", "oneshot")
         .arg("logs")
+        .arg("--service")
         .arg("arb_rs")
         .arg("--lines")
         .arg("1")
