Argus CLI Command Reference

May 29, 2026 · View on GitHub

Complete reference for all 71 Argus CLI commands. Commands are organized into five categories. Each category page contains full synopses, option tables, and output samples. Use the alphabetical index at the bottom to jump directly to any command.

Global Options

--source=auto|agent|jdk   Data source (default: auto)
--no-color                Disable ANSI colors
--lang=en|ko|ja|zh        Output language
--format=table|json       Output format (default: table)
--host HOST               Agent host (default: localhost)
--port PORT               Agent port (default: 9202)
--help, -h                Show help
--version, -v             Show version

Locale resolution order: --lang=<code> flag > $LC_ALL > $LANG > ~/.argus/config.properties (set by argus init) > en fallback.


JSON Output

All commands support --format=json for scripting and pipeline integration:

$ argus --format=json gc 39113
{"totalEvents":0,"totalPauseMs":0.0,"overheadPercent":0.0,"lastCause":"","heapUsed":56849408,"heapCommitted":268435456,"collectors":[{"name":"g1 gc","count":0,"totalMs":0.0}]}

Multi-language Support

Set the output language with --lang or configure it with argus init:

$ argus --lang=ko histo 39113 --top 3

Supported languages: English (en), Korean (ko), Japanese (ja), Chinese (zh)


Categories

Monitoring

Real-time process observation, dashboards, environment inspection, multi-instance cluster health, and alerting. → commands/monitoring.md

  • argus ps — list running JVM processes
  • argus info — JVM version, uptime, VM flags
  • argus env — launch environment (classpath, VM args)
  • argus top — real-time agent dashboard
  • argus watch — htop-style live JVM dashboard
  • argus report — single-view diagnostic report
  • argus diff — heap snapshot comparison (leak detection)
  • argus alert — threshold-based webhook alerting
  • argus cluster — multi-instance aggregated health
  • argus perfcounter — low-level JVM performance counters
  • argus tui — interactive terminal UI (k9s-style)
  • argus harness — continuous trend-aware health watch (doctor + 4 trend rules over a window)

Memory & GC

Heap inspection, GC statistics, NIO buffers, metaspace, classloader leaks, GC log analysis, and ZGC health verdicts. → commands/memory-gc.md

  • argus gc — GC stats (heap usage, pause time, collector)
  • argus gcutil — generation utilization % (jstat-style)
  • argus gcnew — young-gen detail (eden, survivor, tenuring)
  • argus gccause — last/current GC cause with gen utilization
  • argus gcrun — trigger System.gc() remotely
  • argus heap — detailed heap usage with space breakdown
  • argus heapdump — generate heap dump (.hprof)
  • argus histo — heap object histogram (count + size)
  • argus nmt — native memory tracking by category
  • argus buffers — NIO direct/mapped buffer pools
  • argus finalizer — finalizer queue status
  • argus metaspace — metaspace usage by space type
  • argus classstat — class loading throughput
  • argus classleak — classloader-level metaspace leak attribution
  • argus gclog — analyze GC log files (pauses, causes, tuning)
  • argus gclogdiff — compare two GC log files
  • argus gcscore — A–F GC health scorecard
  • argus gcwhy — narrate the worst GC pause in plain English
  • argus gcprofile — JFR-based allocation profiling
  • argus heapanalyze — offline HPROF analysis (MAT alternative)
  • argus g1 — G1GC live health verdict (HEALTHY/WARNING/UNHEALTHY)
  • argus zgc — ZGC live health verdict (HEALTHY/WARNING/UNHEALTHY)

Profiling & Tracing

CPU, allocation, lock, and wall-clock profiling via async-profiler; flame graph generation; JFR control; slow method detection; and method call tracing. → commands/profiling-tracing.md

  • argus profile — CPU/alloc/lock/wall profiling (async-profiler)
  • argus profile-gate — CI/CD CPU regression gate
  • argus flame — one-shot flame graph (HTML, opens browser)
  • argus jfr — JFR start/stop/check/dump
  • argus jfranalyze — analyze JFR recording file
  • argus slowlog — real-time slow method detection (JFR streaming)
  • argus trace — method call tree from thread-dump sampling
  • argus instrument — opt-in live method instrumentation (watch args/return/exception, trace call tree, monitor invocation stats)
  • argus benchmark — sampling-based throughput estimate for a method
  • argus snapshot — forensic bundle (threads + histogram + doctor + JFR + optional heap dump) as a single tar.gz

Runtime & JVM Internals

VM flag inspection and live modification, unified logging control, JMX management, JIT compiler state, class search, Spring Boot integration, and cross-cutting operations tooling. → commands/runtime-internals.md

  • argus vmflag — show/filter non-default VM flags
  • argus vmset — set a manageable VM flag at runtime
  • argus vmlog — control JVM unified logging at runtime
  • argus sysprops — JVM system properties (-D flags)
  • argus compiler — JIT compiler status + code cache usage
  • argus compilerqueue — current JIT compilation queue
  • argus mbean — MBean browser (domains, attributes)
  • argus jmx — JMX management agent control
  • argus dynlibs — native libraries loaded in the JVM
  • argus stringtable — interned string table statistics
  • argus symboltable — JVM symbol table statistics
  • argus sc — search loaded classes by pattern
  • argus classloader — class loader hierarchy + class counts
  • argus spring — Spring Boot app inspection via JMX
  • argus logger — view/change log levels at runtime
  • argus events — VM internal event log (safepoints, deoptimizations)
  • argus explain — explain JVM metrics, GC causes, and flags
  • argus doctor — one-click JVM health diagnosis
  • argus suggest — JVM flag optimization by workload
  • argus ci — CI/CD health gate with exit codes
  • argus compare — side-by-side JVM comparison
  • argus init — first-time setup wizard (language preference)

Threads

Thread state summaries, full thread dumps, deadlock detection, and thread pool distribution analysis. → commands/threads.md

  • argus threads — thread state summary with distribution bars
  • argus threaddump — full thread dump (jstack replacement)
  • argus deadlock — automated deadlock detection
  • argus pool — thread pool grouping with state distribution

All Commands A–Z

CommandCategory
argus alertMonitoring
argus benchmarkProfiling & Tracing
argus buffersMemory & GC
argus ciRuntime & JVM Internals
argus classloaderRuntime & JVM Internals
argus classleakMemory & GC
argus classstatMemory & GC
argus clusterMonitoring
argus compareRuntime & JVM Internals
argus compilerRuntime & JVM Internals
argus compilerqueueRuntime & JVM Internals
argus deadlockThreads
argus diffMonitoring
argus doctorRuntime & JVM Internals
argus dynlibsRuntime & JVM Internals
argus envMonitoring
argus eventsRuntime & JVM Internals
argus explainRuntime & JVM Internals
argus finalizerMemory & GC
argus flameProfiling & Tracing
argus g1Memory & GC
argus gcMemory & GC
argus gccauseMemory & GC
argus gclogMemory & GC
argus gclogdiffMemory & GC
argus gcnewMemory & GC
argus gcprofileMemory & GC
argus gcrunMemory & GC
argus gcscoreMemory & GC
argus gcutilMemory & GC
argus gcwhyMemory & GC
argus harnessMonitoring
argus heapMemory & GC
argus heapanalyzeMemory & GC
argus heapdumpMemory & GC
argus histoMemory & GC
argus infoMonitoring
argus initRuntime & JVM Internals
argus instrumentProfiling & Tracing
argus jfrProfiling & Tracing
argus jfranalyzeProfiling & Tracing
argus jmxRuntime & JVM Internals
argus loggerRuntime & JVM Internals
argus mbeanRuntime & JVM Internals
argus metaspaceMemory & GC
argus nmtMemory & GC
argus perfcounterMonitoring
argus poolThreads
argus pool jdbcThreads
argus pool adviseThreads
argus profileProfiling & Tracing
argus profile-gateProfiling & Tracing
argus psMonitoring
argus reportMonitoring
argus rightsizeRuntime & JVM Internals
argus scRuntime & JVM Internals
argus slowlogProfiling & Tracing
argus snapshotProfiling & Tracing
argus springRuntime & JVM Internals
argus stringtableRuntime & JVM Internals
argus suggestRuntime & JVM Internals
argus symboltableRuntime & JVM Internals
argus syspropsRuntime & JVM Internals
argus threaddumpThreads
argus threadsThreads
argus topMonitoring
argus traceProfiling & Tracing
argus tuiMonitoring
argus vmflagRuntime & JVM Internals
argus vmlogRuntime & JVM Internals
argus vmsetRuntime & JVM Internals
argus watchMonitoring
argus zgcMemory & GC