Enum OutputMode 

pub enum OutputMode {
    Plain,
    Rich,
    Json,
}

Output mode for console rendering.

Determines how console output should be formatted. The mode is automatically detected based on environment variables and terminal state, but can be overridden via SQLMODEL_PLAIN, SQLMODEL_RICH, or SQLMODEL_JSON.

Variants

Plain

Plain text output, no ANSI codes. Machine-parseable.

Used for: AI agents, CI systems, piped output, dumb terminals.

Rich

Rich formatted output with colors, tables, panels.

Used for: Interactive human terminal sessions.

Json

Structured JSON output for programmatic consumption.

Used for: Tool integrations, scripting, IDEs.

Implementations

impl OutputMode

pub fn detect() -> Self

Detect the appropriate output mode from the environment.

This function checks various environment variables and terminal state to determine the best output mode. The detection is deterministic and follows a well-defined priority order.

Priority Order

1. SQLMODEL_PLAIN=1 - Force plain output
2. SQLMODEL_JSON=1 - Force JSON output
3. SQLMODEL_RICH=1 - Force rich output (overrides agent detection!)
4. NO_COLOR present - Plain (standard convention)
5. CI=true - Plain (CI environment)
6. TERM=dumb - Plain (dumb terminal)
7. Agent environment detected - Plain
8. stdout is not a TTY - Plain
9. Default - Rich

Examples

use sqlmodel_console::OutputMode;

let mode = OutputMode::detect();
match mode {
    OutputMode::Plain => println!("Using plain text"),
    OutputMode::Rich => println!("Using rich formatting"),
    OutputMode::Json => println!("Using JSON output"),
}

pub fn is_agent_environment() -> bool

Check if we’re running in an AI coding agent environment.

This function checks for environment variables set by known AI coding assistants. When detected, we default to plain output to ensure machine-parseability.

Known Agent Environment Variables

• CLAUDE_CODE - Claude Code CLI
• CODEX_CLI - OpenAI Codex CLI
• CURSOR_SESSION - Cursor IDE
• AIDER_MODEL / AIDER_REPO - Aider coding assistant
• AGENT_MODE - Generic agent marker
• GITHUB_COPILOT - GitHub Copilot
• CONTINUE_SESSION - Continue.dev extension
• CODY_* - Sourcegraph Cody
• WINDSURF_* - Windsurf/Codeium
• GEMINI_CLI - Google Gemini CLI

Returns

true if any agent environment variable is detected.

Examples

use sqlmodel_console::OutputMode;

if OutputMode::is_agent_environment() {
    println!("Running under an AI agent");
}

pub const fn supports_ansi(&self) -> bool

Check if this mode should use ANSI escape codes.

Returns true only for Rich mode, which is the only mode that uses colors and formatting.

Examples

use sqlmodel_console::OutputMode;

assert!(!OutputMode::Plain.supports_ansi());
assert!(OutputMode::Rich.supports_ansi());
assert!(!OutputMode::Json.supports_ansi());

pub const fn is_structured(&self) -> bool

Check if this mode uses structured format.

Returns true only for Json mode, which outputs structured data for programmatic consumption.

Examples

use sqlmodel_console::OutputMode;

assert!(!OutputMode::Plain.is_structured());
assert!(!OutputMode::Rich.is_structured());
assert!(OutputMode::Json.is_structured());

pub const fn is_plain(&self) -> bool

Check if this mode is plain text.

Examples

use sqlmodel_console::OutputMode;

assert!(OutputMode::Plain.is_plain());
assert!(!OutputMode::Rich.is_plain());
assert!(!OutputMode::Json.is_plain());

pub const fn is_rich(&self) -> bool

Check if this mode uses rich formatting.

Examples

use sqlmodel_console::OutputMode;

assert!(!OutputMode::Plain.is_rich());
assert!(OutputMode::Rich.is_rich());
assert!(!OutputMode::Json.is_rich());

pub const fn as_str(&self) -> &'static str

Get the mode name as a string slice.

Examples

use sqlmodel_console::OutputMode;

assert_eq!(OutputMode::Plain.as_str(), "plain");
assert_eq!(OutputMode::Rich.as_str(), "rich");
assert_eq!(OutputMode::Json.as_str(), "json");

Trait Implementations

impl Clone for OutputMode

fn clone(&self) -> OutputMode

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OutputMode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OutputMode

fn default() -> OutputMode

Returns the “default value” for a type.

impl Display for OutputMode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for OutputMode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for OutputMode

fn eq(&self, other: &OutputMode) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for OutputMode

impl Eq for OutputMode

impl StructuralPartialEq for OutputMode