Package org.jline.shell

package org.jline.shell

Clean shell API for building interactive command-line applications with JLine.

This package provides the core abstractions for commands, command groups, command dispatching, pipelines, and job management.

Architecture

 jline-terminal
   ^
 jline-reader
   ^
 jline-shell  (this module)
   ^
 jline-console
 

Core Types

• Command - a single executable command
• CommandGroup - a named group of commands
• CommandDispatcher - resolves and executes commands
• CommandSession - execution context (terminal, I/O, variables)
• Shell - the REPL loop
• Pipeline - parsed pipeline of commands
• Job - job control

Quick Start

 Shell shell = Shell.builder()
     .prompt("myapp> ")
     .groups(myGroup)
     .build();
 shell.run();
 

Since:

4.0

Related Packages

Package	Description
org.jline.shell.impl	Default implementations of the shell API interfaces.
org.jline.shell.widget	Widgets for the JLine shell API.

Class	Description
AliasManager	Manages command aliases for the shell.
ArgumentDescription	Describes a command argument with a name and optional description.
Command	Represents a single executable command in the shell.
CommandDescription	Describes a command for help display and widget integration.
CommandDescription.Builder	Builder for CommandDescription instances.
CommandDispatcher	Central dispatcher that aggregates CommandGroups and handles command resolution, execution, and completion.
CommandGroup	A named group of Commands for organization and discovery.
CommandLine	Represents a parsed command line with its components.
CommandLine.Type	The type of description that should be displayed.
CommandSession	Encapsulates the execution context for a command, including the terminal, I/O streams, session variables, working directory, and job state.
Job	Represents a job in the shell's job control system.
Job.Status	Job lifecycle status.
JobListener	Listener for job status changes.
JobManager	Manages jobs in the shell's job control system.
LineExpander	Expands variables and other expressions in a command line before parsing.
Pipeline	Represents a pipeline of commands connected by operators such as pipes, redirections, and conditional connectors.
Pipeline.Operator	Operators that connect commands in a pipeline.
Pipeline.Stage	A single stage in a pipeline, consisting of a command line and the operator that follows it.
PipelineBuilder	Fluent builder for constructing Pipeline instances programmatically.
ScriptRunner	Executes a script file line by line through a CommandDispatcher.
Shell	An interactive shell that runs a read-eval-print loop (REPL) using a CommandDispatcher for command execution.
ShellBuilder	Builder for creating Shell instances.
UnknownCommandException	This exception is thrown by an CommandDispatcher when it failed to find a requested command.