Skip to content
CAI
Software that uses CAICheck a score

zio/zio-cli

55.9

Adequate · 7 November 2026

7.2k

lines of production code

Scala

primary language

4

measurements over time

CAI band scale
CAI trend line
CAI lens gauges

What this system is

Features

Add JVM-specific file system implementation

Introduces the \FileSystemPlatformSpecific\ trait for the JVM target, providing concrete implementations for file system operations such as parsing paths, checking existence, and verifying whether a path is a directory or regular file using \java.nio.file\ APIs.

zio-cli/jvm/src/main/scala/zio/cli/files · high confidence

Add OAuth2 example application

A new example application demonstrating OAuth2 authorization has been added to the JVM examples. This sample CLI app, named 'ZIO CLI OAuth2', illustrates how to integrate OAuth2 providers (specifically GitHub in this configuration) and handle access tokens within a ZIO CLI command structure.

examples/jvm · high confidence

Add Scala Native platform support to zio-cli

This change introduces platform-specific implementations for the Scala Native target, mirroring the existing Scala.js support. For users, this means zio-cli can now be compiled and run on Scala Native. The diff adds specific modules for handling arguments, options, file system operations, and completion generation. Notably, while the Scala.js implementation stubs out file system and completion features (returning empty results or errors), the Scala Native implementation provides actual functionality using \java.nio.file\ APIs for parsing paths, checking existence, and distinguishing between files and directories. OAuth2 support remains unimplemented for both platforms, as indicated by the shared stub code.

zio-cli/js · high confidence

Add sbt plugin for building native images of ZIO CLI apps

The sbt-zio-cli module now includes a new SBT plugin (ZIOCLIPlugin) that integrates with the native-image build process. This plugin adds settings to configure native image options (such as allowing incomplete classpaths and initializing at build time) and provides tasks to build the native image, though bash/zsh completion and CLI installation tasks are currently marked as not implemented.

sbt-zio-cli · high confidence

Added JVM-specific OAuth2 authorization support

This change introduces the core OAuth2 authorization logic and platform-specific integration for the JVM target. It adds a new \OAuth2\ class that handles token loading, caching, expiration checks, and automatic refreshing via the standard Java \HttpClient\. Additionally, it provides \OAuth2PlatformSpecific\ utilities to validate OAuth2 options, locate the authentication provider within the CLI option tree, and generate help documentation explaining the third-party authorization flow to users.

zio-cli/jvm/src/main/scala/zio/cli/oauth2 · high confidence

Added slant.fig font resource for CLI banner generation

The CLI module now includes the 'slant' FIGfont resource file (slant.flf) in its shared resources. This addition enables the CLI tool to render text banners using the slant font style, expanding the available visual formatting options for command-line output.

zio-cli/shared/src/main/resources · high confidence

Initial documentation for ZIO CLI website

The website now includes comprehensive documentation for ZIO CLI, covering core concepts such as Args, Options, Commands, and HelpDoc construction. It provides guides on configuring CliApp behavior (case sensitivity, autocorrection), integrating OAuth2 authentication (GitHub, Google, Facebook), and generating Bash/Zsh tab completions. Additionally, it details the SBT plugin for building native images and lists built-in commands like --help and --wizard.

website · high confidence

Initial release of ZIO CLI library

This change introduces the ZIO CLI library, providing a comprehensive framework for building command-line applications in Scala. It includes core abstractions for defining commands, options, and arguments (Args, Options, Command), along with support for primitive types like integers, booleans, paths, and Java time types. Key features include automatic help documentation generation, subcommand nesting, auto-correction for misspelled options, and Bash tab completion. The library also supports OAuth2 authentication and integrates with ZIO's effect system for error handling and configuration.

zio-cli/shared/src/main/scala/zio · high confidence

Introduce ZIO CLI testkit and example applications

This release adds a new testkit module (zio-cli-testkit) providing utilities like CliRepr, TestReturn, and Tree to help developers test their CLI applications, alongside new example applications (GitExample, WcApp, StringUtil) that demonstrate how to build and run ZIO-based command-line tools.

repository · high confidence

JVM-specific CLI argument and completion support

This change introduces platform-specific implementations for the JVM target, enabling file and directory argument parsing, OAuth2 authorization options, and Bash tab-completion via the \compgen\ utility. Users can now define file and directory arguments with existence checks, integrate OAuth2 providers for authentication, and benefit from improved shell completion for file paths and directories on JVM-based systems.

zio-cli/jvm/src/main/scala/zio/cli · high confidence

Native executable installer and updated build configuration

Users can now install the application as a native executable via the new installer.sh script, which automatically downloads and configures GraalVM to build a standalone binary if native-image is not already present, falling back to running the JAR otherwise. The project's build environment has been updated to use scalafmt 3.11.5 with Scala 2.13 Source 3 dialect, and the local sbt runner script has been removed in favor of the standard sbt launcher.

(repo-wide) · high confidence

New CLI testkit utilities for asserting and property-testing commands and apps

The zio-cli-testkit module now includes \CliAssertion\ and \GenerationAssertion\ objects, providing methods to verify \CliApp\ and \Command\ behavior. Users can assert specific properties like help documentation and usage synopses, validate command parsing results (including error handling), and test full application execution outcomes. Additionally, the new \GenerationAssertion\ utilities support property-based testing, allowing developers to generate random inputs and seeds to automatically verify that dynamically created commands and applications behave correctly across various scenarios.

zio-cli-testkit/shared · high confidence

Removals

Removal of HelloWorld example code

The HelloWorld.scala file, which contained a sample ZIO application demonstrating basic console interaction, has been removed from the zio-cli shared source directory.

zio-cli/shared/src/main/scala/zio-cli · high confidence

Behavioural changes

Platform-specific FigFont loading on JVM

The JVM-specific implementation for loading Figlet fonts now uses ZIO 2's effect types (ZIO) for file, resource, and URL operations, replacing previous platform-agnostic or non-ZIO approaches with \attemptBlockingIO\ to handle I/O safely.

zio-cli/jvm/src/main/scala/zio/cli/figlet · high confidence

Fixes

Add Scala 2.11 compatibility backfills

The zio-cli library now supports Scala 2.11 by introducing a compatibility package that provides backfill implementations for methods missing in that version. Specifically, it adds implicit classes to convert \Try\ to \Either\, \Either\ to \Option\, and \String\ to \Option\[Int\]\, ensuring the CLI tool builds and functions correctly on older Scala runtimes.

zio-cli/shared/src/main/scala-2.11 · high confidence

Test coverage

Added standard.figlet font resource for testing; Added test coverage for CLI argument validation, primitive types, wizard interaction, and shell completion; Added tests for FigFont parsing and rendering; Added tests for Figlet font rendering and parsing logic; Expanded test coverage for ZIO CLI core components; Removed HelloWorldSpec test file.

Dependencies

Upgrade to ZIO 2.1 and ZIO-JSON 1.0 with Native platform support

The project has upgraded its core dependencies to ZIO 2.1.26 and ZIO-JSON 1.0.0, migrating from the ZIO 1.x API. This change introduces official support for the Native platform alongside existing JVM and JS targets, adding \scala-java-time\ as a dependency for time handling on Native and JS. The build configuration now uses \zio-sbt-ci\ for automated CI generation, updates the homepage URL to zio.dev, and includes \zio-process\ for JVM-specific process management.

(dependencies) · high confidence

Upgrade to sbt 2.0 and Scala 3.3.8 with plugin modernization

The build system has been upgraded from sbt 1.3.7 to sbt 2.0.9, and the default Scala version is now 3.3.8 (dropping support for Scala 2.11 and Dotty). This change requires updating several sbt plugins to versions compatible with sbt 2, including sbt-buildinfo (0.13.2), sbt-scalajs (1.22.0), and sbt-scalafix (0.14.9), while removing obsolete plugins like sbt-dotty and sbt-explicit-dependencies. The build helper logic has been adjusted to handle Scala 3 compiler options and explicit BuildInfoKey typing required by the new sbt/Scala 3 axis.

project · high confidence

Written by cca.canine.dev from the codebase's own history, inside the signed delivery this page is composed from.

How this codebase got here

Score

  • CAI 55 → 56 (+1.2)
  • Rubric changed (rubric-2026.10.5 → rubric-2026.11.2) — scores are not directly comparable.

Lenses

  • Code Health 73 → 73 (+0.0)
  • Architecture 91 → 90 (-1.4)
  • Maturity 33 → 48 (+15.9)
  • Readiness 85 → 68 (-16.8)
  • Security 65 → 48 (-17.3)
  • Performance 100 → 100 (+0.0)

Resolved (7)

  • Outdated: dev.zio:zio-json_2.12
  • Outdated: dev.zio:zio-process_2.12
  • Outdated: dev.zio:zio-streams_2.12
  • Outdated: dev.zio:zio-test-magnolia_2.12
  • Outdated: dev.zio:zio-test-sbt_2.12
  • Outdated: dev.zio:zio-test_2.12
  • Outdated: dev.zio:zio_2.12

New (1)

  • Dependency hygiene PARTLY measured — sbt declarations read, dependency currency not (Maven Central unreachable)

Changes since last survey

  • 3 commits — 3 feature/other, 0 fixes

By area

  • (repo) — 1 commit
  • .github/workflows — 1 commit
  • project/BuildHelper.scala — 1 commit

Notable commits

  • change: Update scala3-library, ... to 3.3.9 (#665)
  • change: Update zio-sbt-ci, zio-sbt-website to 0.8.7 (#667)
  • change: build(deps): bump scala-steward-org/scala-steward-action from 2.96.0 to 2.97.0 (#661)

Architecture

  • Unchanged — 0 containers · 1 contexts · 0 edges

Written by cca.canine.dev from the codebase's own history, inside the signed delivery this page is composed from.

Survey your own repository

zio/zio-cli was measured the same way every project in this corpus was: the same rubric, at a pinned commit, with the result published in full. Point a surveyor at a repository you know and see whether you agree with it.

About this page

  • The score is its most recent published measurement, taken on 7 November 2026 at a pinned commit. It is not a live figure and does not change until the project is measured again.
  • Measured at commit 9360c3d7a56aa01a7ea98e227b83b052172c71d7 — the exact code this score is about.
  • Scored under rubric-2026.11.2 — the same rubric and the same method as every other entry in this index.
  • Measured by Canine Code Analyzer (cca.canine.dev) using cca measure-2026.11.3+preprod-c34be012586e.