laravel/tinker
Tinker
Laravel Tinker is an interactive shell that boots the full Laravel application context, allowing you to run PHP code, test models, and experiment with the framework in real time from the command line. It integrates PsySH as its underlying REPL engine, providing features like automatic namespace resolution, command history persistence, and on-demand class loading through Composer's autoloader.
The tool handles the full lifecycle of a Laravel console command, from defining input signatures and prompting for missing arguments to executing commands programmatically and queuing them for background processing. It also includes mechanisms for preventing concurrent command execution, listening to operating system signals, and writing formatted output such as colored text, tables, and progress bars to the terminal.
Beyond the core REPL experience, Tinker supports registering commands from custom directories, customizing generated file stubs, and hooking into command lifecycle events for additional logic or logging. The documentation covers installation, configuration, and usage through the standard Laravel package publishing workflow.
Features
- Interactive REPLs - Runs an interactive command-line shell that loads the full application context for live code experimentation.
- Laravel REPLs - Provides an interactive shell that boots the full Laravel application context for live code experimentation.
- Application Context Bootstrappers - Loads the Laravel service container, configuration, and facades before entering the interactive shell session.
- REPL Integrations - Integrates PsySH as the underlying REPL engine for evaluating PHP expressions interactively.
- Real-Time Code Evaluation - Evaluates arbitrary PHP expressions and statements in real time within the application's runtime environment.
- PsySH-Based REPL Engines - Embeds the PsySH runtime debugger as the interactive shell engine for autocompletion, history, and runtime introspection.
- Automatic Import Resolution - Resolves and imports class names automatically within the REPL session based on the application's namespace map.
- Application-Context REPL Shells - Opens an interactive PHP shell that boots the full Laravel application context for live code experimentation.
- Laravel REPL Shells - Provides an interactive command-line shell that loads the full Laravel application context for live code experimentation.
- Laravel - Boots the full Laravel application context before entering the interactive shell session.
- Programmatic Command Invokers - Runs a command from within application code, such as a route or controller, and retrieves its exit code.
- Command Chaining - Invokes one command from within another, optionally suppressing its output.
- Signature-Based Input Parsers - Defines required and optional arguments and options for console commands using a concise signature syntax.
- Missing Argument Prompts - Automatically prompts users for required command arguments that were not provided at invocation.
- Command Options - Accesses user-supplied arguments and options from within command execution logic.
- Command Signature Declarations - Declares a command's name, arguments, and options using a compact, route-like syntax within the command class.
- Command Signature Definitions - Specifies required and optional arguments and options for console commands using a concise signature syntax.
- Programmatic - Executes Artisan commands programmatically from application code and retrieves their exit codes.
- Composer Autoloader Integrations - Loads application classes and dependencies on demand during REPL sessions using Composer's autoloader.
- Namespace Resolvers - Resolves and imports class names automatically within the REPL session based on the application's namespace map.
- Console Output Formatting - Writes colored text, tables, and progress bars to the console to communicate status and results.
- Formatted Console Outputs - Writes colored text, tables, and progress bars to the terminal for status and results.
- Command History Persistence - Stores and retrieves previously executed REPL commands across sessions using a file-based history system.
- Input Selection Prompts - Asks users for text, secrets, or selections during command execution with defaults and validation.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
