Skip to content

A plugin that gives users the ability to use the terminal on the web!

License

Notifications You must be signed in to change notification settings

thethunderturner/filament-xterm

Repository files navigation

Filament Xterm

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

A filament plugin that gives you access to a terminal in your browser. It uses the xterm.js library to create a terminal emulator in your browser.

Caution

Please make sure the widget has proper permissions and is secure. This widget can be used to run commands on your server. Make sure you have proper security measures in place. Otherwise you might be at risk of being hacked and/or having your data compromised.

Installation

You can install the package via composer:

composer require thethunderturner/filament-xterm

You can publish the config file with:

php artisan vendor:publish --tag="filament-xterm-config"

Optionally, you can publish the views using

php artisan vendor:publish --tag="filament-xterm-views"

Usage

Simply add the widget to your page using the following code:

protected function getHeaderWidgets(): array
{
    return [
        \TheThunderTurner\FilamentXterm\FilamentXtermWidget::class,
    ];
}

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

About

A plugin that gives users the ability to use the terminal on the web!

Resources

License

Security policy

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published