nova-tinker-tool - GitLite

KO | EN

gitlite — search

#javascript #typescript #golang #go #android #machine-learning #rust #deep-learning #docker #nodejs #windows #awesome-list #security #mcp

nova-tinker-tool

(★ 115)

Use the power of Tinker within your Nova application.

File Explorer

Download Latest Version (.zip)

- - tool.css
- - tool.js
- - tool.js
- - tool.scss
- - navigation.blade.php
- api.php
- Tinker.php
- TinkerToolServiceProvider.php
.editorconfig
.gitignore
.scrutinizer.yml
.styleci.yml
.travis.yml
CHANGELOG.md
composer.json
CONTRIBUTING.md
LICENSE.md
mix-manifest.json
package.json
phpunit.xml.dist
README.md
webpack.mix.js
yarn.lock

# Installation Guide

1. Get the code

git clone https://github.com/beyondcode/nova-tinker-tool

Downloads the entire project code from GitHub to your computer.

cd nova-tinker-tool

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

3. PHP (Composer)

Easy

Prerequisites

Git Needed to download the project code from GitHub.
PHP A PHP runtime is required.
Composer The package manager used to install PHP libraries.

composer require beyondcode/nova-tinker-tool

Type this command into your terminal and run it.

✅ Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Nova Tinker Tool

[![Latest Version on Packagist](https://img.shields.io/packagist/v/beyondcode/nova-tinker-tool.svg?style=flat-square)](https://packagist.org/packages/beyondcode/nova-tinker-tool)
[![Total Downloads](https://img.shields.io/packagist/dt/beyondcode/nova-tinker-tool.svg?style=flat-square)](https://packagist.org/packages/beyondcode/nova-tinker-tool)

Use the power of Tinker within your Nova application.

![tinker screenshot](https://beyondco.de/github/nova-tinker-tool/screenshot.png)

## Installation

You can install the package in to a Laravel app that uses [Nova](https://nova.laravel.com) via composer:

```bash
composer require beyondcode/nova-tinker-tool
```

Next up, you must register the tool with Nova. This is typically done in the `tools` method of the `NovaServiceProvider`.

```php
// in app/Providers/NovaServiceProvider.php

// ...
public function tools()
{
    return [
        // ...
        new \Beyondcode\TinkerTool\Tinker(),
    ];
}
```

## Usage

Click on the new "Tinker" menu item in your Nova application. You can enter any PHP code and press CMD+Enter / CTRL+Enter to evaluate the expression.
The return value will be displayed below.

The previous code and output will be stored in the localstorage in case you want to execute the same code snippets multiple times.

### Settings

By default this Pysh will attempt to write to ~/.pysh which for most will result in an error when trying to use tinker. To avoid this issue adding an environment variable to change where Pysh will write to will resolve this:
```bash
XDG_CONFIG_HOME=/path/to/new/location
```

### Security: Remote Code Execution

This should only be used for development and testing. Running tinker allows arbitrary code to be executed.

Any executed php code will have the same access as the running php instance. This means that the running application may be altered, and if run with root privileges, one can get complete control of the machine.

### Testing

``` bash
composer test
```

### Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

### Security

If you discover any security related issues, please email marcel@beyondco.de instead of using the issue tracker.

## Credits

- [Marcel Pociot](https://github.com/mpociot)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.