22 |
23 | Get more details: [https://github.com/nunomaduro/laravel-desktop-notifier](https://github.com/nunomaduro/laravel-desktop-notifier).
24 |
25 |
--------------------------------------------------------------------------------
/source/docs/http-client.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: HTTP Client
3 | description: Laravel Zero includes a minimal HTTP Client component
4 | extends: _layouts.documentation
5 | section: content
6 | ---
7 |
8 | # HTTP Client
9 |
10 | Laravel includes an expressive API around the [Guzzle HTTP client](https://github.com/guzzle/guzzle).
11 | This can easily be installed into Laravel Zero using the `http` component.
12 |
13 | To install this component, run the following command:
14 |
15 | ```shell
16 | php 
29 |
30 | Get more details: [https://github.com/nunomaduro/laravel-console-task](https://github.com/nunomaduro/laravel-console-task).
31 |
32 |
--------------------------------------------------------------------------------
/source/_assets/js/main.js:
--------------------------------------------------------------------------------
1 | window.docsearch = require('docsearch.js');
2 |
3 | import hljs from 'highlight.js/lib/highlight';
4 |
5 | hljs.registerLanguage('bash', require('highlight.js/lib/languages/bash'));
6 | hljs.registerLanguage('css', require('highlight.js/lib/languages/css'));
7 | hljs.registerLanguage('diff', require('highlight.js/lib/languages/diff'));
8 | hljs.registerLanguage('html', require('highlight.js/lib/languages/xml'));
9 | hljs.registerLanguage('javascript', require('highlight.js/lib/languages/javascript'));
10 | hljs.registerLanguage('json', require('highlight.js/lib/languages/json'));
11 | hljs.registerLanguage('markdown', require('highlight.js/lib/languages/markdown'));
12 | hljs.registerLanguage('php', require('highlight.js/lib/languages/php'));
13 | hljs.registerLanguage('scss', require('highlight.js/lib/languages/scss'));
14 | hljs.registerLanguage('yaml', require('highlight.js/lib/languages/yaml'));
15 |
16 | document.querySelectorAll('pre code').forEach((block) => {
17 | hljs.highlightBlock(block);
18 | });
19 |
--------------------------------------------------------------------------------
/source/docs/navigation.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Navigation
3 | description: Building a navigation menu for your site
4 | extends: _layouts.documentation
5 | section: content
6 | ---
7 |
8 | # Navigation {#navigation}
9 |
10 | The navigation menu in the left-hand sidebar is defined using an array in `navigation.php`. Nested pages can be added by using the `children` associative array.
11 |
12 | ```php
13 | [
18 | 'url' => 'docs/getting-started',
19 | 'children' => [
20 | 'Customizing Your Site' => 'docs/customizing-your-site',
21 | 'Navigation' => 'docs/navigation',
22 | 'Algolia DocSearch' => 'docs/algolia-docsearch',
23 | 'Custom 404 Page' => 'docs/custom-404-page',
24 | ],
25 | ],
26 | 'Jigsaw Docs' => 'https://jigsaw.tighten.co/docs/installation',
27 | ];
28 |
29 | // config.php
30 | 'navigation' => require_once('navigation.php'),
31 |
32 | // blade files
33 | $page->navigation
34 | ```
35 |
--------------------------------------------------------------------------------
/config.php:
--------------------------------------------------------------------------------
1 | '',
7 | 'production' => false,
8 | 'siteName' => 'Laravel Zero',
9 | 'siteDescription' => 'Micro-framework for console applications',
10 |
11 | // Algolia DocSearch credentials
12 | 'docsearchApiKey' => 'ac0bd380724d207df97763a999031e82',
13 | 'docsearchIndexName' => 'laravel-zero',
14 |
15 | // navigation menu
16 | 'navigation' => require_once('navigation.php'),
17 |
18 | // helpers
19 | 'isActive' => function ($page, $path) {
20 | return Str::endsWith(trimPath($page->getPath()), trimPath($path));
21 | },
22 | 'isActiveParent' => function ($page, $menuItem) {
23 | if (is_object($menuItem) && $menuItem->children) {
24 | return $menuItem->children->contains(function ($child) use ($page) {
25 | return trimPath($page->getPath()) == trimPath($child);
26 | });
27 | }
28 | },
29 | 'url' => function ($page, $path) {
30 | return Str::startsWith($path, 'http') ? $path : '/' . trimPath($path);
31 | },
32 | ];
33 |
--------------------------------------------------------------------------------
/source/docs/environment-variables.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Environment Variables
3 | description: Dotenv component loads environment variables from a .env file
4 | extends: _layouts.documentation
5 | section: content
6 | ---
7 |
8 | # Environment Variables
9 |
10 | Using the `app:install` Artisan command you can install the `dotenv` component:
11 | ```bash
12 | php
18 |
22 | 23 |
25 | @endsection
26 | ```
27 |
28 | ---
29 |
30 | Depending on where your site is hosted, you may need to configure your server to use the custom 404 page. For more details, visit the [Jigsaw documentation about configuring a custom 404 page.](https://jigsaw.tighten.co/docs/custom-404-page/)
31 |
--------------------------------------------------------------------------------
/source/docs/introduction.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Introduction
3 | description: About Laravel Zero and it's documentation
4 | extends: _layouts.documentation
5 | section: content
6 | ---
7 |
8 | # Introduction
9 |
10 | Laravel Zero was created by, and is maintained by **[Nuno Maduro](https://github.com/nunomaduro)**, and is
11 | a micro-framework that provides an elegant starting point for your console application. It is an **unofficial**
12 | and customized version of Laravel optimized for building command-line applications.
13 |
14 | It’s built on top of the latest release of Laravel, the most popular PHP web framework. Using Laravel Zero, you are free to take
15 | advantage of Laravel's core great features, and at the same time leverage minimal application structure and a lightweight experience.
16 |
17 | Laravel Zero is **100% open source**, so you’re free to dig through the source to see exactly how it works. See something that needs to be improved? Just send us a [pull request on GitHub](https://github.com/laravel-zero).
18 |
19 | Let's get you started:
20 | - [Installation](/docs/installation)
21 | - [Usage](/docs/commands)
22 | - [Add-ons](/docs/database)
23 | - [Upgrade](/docs/upgrade)
24 | - [Contributing](/docs/contributing)
25 |
--------------------------------------------------------------------------------
/source/assets/img/icon-stack.svg:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/source/docs/database.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Database
3 | description: Database
4 | extends: _layouts.documentation
5 | section: content
6 | ---
7 |
8 | # Database
9 |
10 | Using the `app:install` Artisan command you can install the `database` component:
11 | ```bash
12 | php 404
19 |Page not found
20 | 21 |22 | 23 |
Need to update this page? See the documentation here.
24 |
38 | 
39 |
22 |
23 | This command will install dependencies needed and publishes a config file under `config/logo.php`.
24 |
25 | ### Using a different font
26 |
27 | Under the hood the `logo` component uses the [`laminas/laminas-text`](https://github.com/laminas/laminas-text) package which renders text using fonts called "figlets".
28 |
29 | By default Laravel Zero uses the `big.flf` FIGlet file by Glenn Chappell. Additional FIGlet files can be downloaded from [figlet.org](http://www.figlet.org/fontdb.cgi) or created using FIGlet editing software.
30 |
31 | Once a font has been downloaded, the `logo.font` value can be set in the config to provide the full path to the FIGlet file.
32 |
33 | ```diff
34 | // config/logo.php
35 | - 'font' => \LaravelZero\Framework\Components\Logo\FigletString::DEFAULT_FONT,
36 | + 'font' => resources_path('fonts/doom.flf'),
37 | ```
38 |
39 | For more details, check out the [Laminas docs](https://docs.laminas.dev/laminas-text/figlet) on FIGlets.
40 |
--------------------------------------------------------------------------------
/tasks/build.js:
--------------------------------------------------------------------------------
1 | let argv = require('yargs').argv;
2 | let bin = require('./bin');
3 | let command = require('node-cmd');
4 |
5 | let BrowserSync = require('browser-sync');
6 | let BrowserSyncPlugin = require('browser-sync-webpack-plugin');
7 | let ExtraWatchWebpackPlugin = require('extra-watch-webpack-plugin');
8 |
9 | let browserSyncInstance;
10 | let env = argv.e || argv.env || 'local';
11 | let port = argv.p || argv.port || 3000;
12 |
13 | module.exports = {
14 | jigsaw: {
15 | apply(compiler) {
16 | compiler.hooks.done.tap('DonePlugin', (compilation) => {
17 | command.get(bin.path() + ' build -q ' + env, (error, stdout, stderr) => {
18 | console.log(error ? stderr : stdout);
19 |
20 | if (browserSyncInstance) {
21 | browserSyncInstance.reload();
22 | }
23 | });
24 | });
25 | }
26 | },
27 |
28 | watch: function (paths) {
29 | return new ExtraWatchWebpackPlugin({
30 | files: paths,
31 | });
32 | },
33 |
34 | browserSync: function (proxy) {
35 | return new BrowserSyncPlugin({
36 | notify: false,
37 | port: port,
38 | proxy: proxy,
39 | server: proxy ? null : { baseDir: 'build_' + env + '/' },
40 | },
41 | {
42 | reload: false,
43 | callback: function() {
44 | browserSyncInstance = BrowserSync.get('bs-webpack-plugin');
45 | },
46 | })
47 | },
48 | };
49 |
--------------------------------------------------------------------------------
/navigation.php:
--------------------------------------------------------------------------------
1 | [
5 | 'url' => 'docs/introduction',
6 | ],
7 | 'Installation' => [
8 | 'url' => 'docs/installation',
9 | ],
10 | 'Usage' => [
11 | 'url' => 'docs/commands',
12 | 'children' => [
13 | 'Commands' => 'docs/commands',
14 | 'Service Providers' => 'docs/service-providers',
15 | 'Configuration' => 'docs/configuration',
16 | 'Testing' => 'docs/testing',
17 | ],
18 | ],
19 | 'Exception handler' => [
20 | 'url' => 'docs/exception-handler',
21 | ],
22 | 'Add-ons' => [
23 | 'url' => 'docs/database',
24 | 'children' => [
25 | 'Database' => 'docs/database',
26 | 'Logging' => 'docs/logging',
27 | 'Filesystem' => 'docs/filesystem',
28 | 'Run tasks' => 'docs/run-tasks',
29 | 'Create a logo' => 'docs/create-a-logo',
30 | 'Build interactive menus' => 'docs/build-interactive-menus',
31 | 'Send desktop notifications' => 'docs/send-desktop-notifications',
32 | 'Web Browser Automation' => 'docs/web-browser-automation',
33 | 'Environment Variables' => 'docs/environment-variables',
34 | 'Build a standalone application' => 'docs/build-a-standalone-application',
35 | 'Tinker REPL' => 'docs/tinker-repl',
36 | 'HTTP Client' => 'docs/http-client',
37 | ],
38 | ],
39 | 'Upgrade' => [
40 | 'url' => 'docs/upgrade',
41 | ],
42 | 'Contributing' => [
43 | 'url' => 'docs/contributing',
44 | ],
45 | ];
46 |
--------------------------------------------------------------------------------
/source/docs/installation.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Installation
3 | description: Create a new Laravel Zero project
4 | extends: _layouts.documentation
5 | section: content
6 | ---
7 |
8 | # Installation
9 |
10 | > **Requires [PHP 7.3+](https://php.net/releases)**
11 |
12 | Laravel Zero utilizes [Composer](https://getcomposer.org) to manage its dependencies. So, before using Laravel Zero, make sure you have Composer installed on your machine.
13 |
14 | #### Via Laravel Zero Installer
15 |
16 | First, download the Laravel Zero installer using Composer:
17 |
18 | ```bash
19 | composer global require "laravel-zero/installer"
20 | ```
21 |
22 | Make sure to place composer's system-wide vendor bin directory in your `$PATH` so the laravel Zero executable can be located by your system. This directory exists in different locations based on your operating system. On macOS and GNU/Linux distributions, it's `$HOME/.composer/vendor/bin`.
23 |
24 | Once installed, the `laravel-zero new` command will create a fresh Laravel Zero installation in the directory you specify. For instance, `laravel-zero new movie-cli` will create a directory named `movie-cli` containing a fresh Laravel Zero installation with all of Laravel Zero's dependencies already installed:
25 |
26 | ```bash
27 | laravel-zero new movie-cli
28 | ```
29 |
30 | #### Via Composer Create-Project
31 |
32 | Alternatively, you may also install Laravel Zero by issuing the Composer `create-project` command in your terminal:
33 |
34 | ```bash
35 | composer create-project --prefer-dist laravel-zero/laravel-zero movie-cli
36 | ```
37 |
38 | You will then need to run the `app:rename` command to rename your project:
39 |
40 | ```bash
41 | php application app:rename [movie-cli]
42 | ```
43 |
--------------------------------------------------------------------------------
/source/docs/logging.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Logging
3 | description: Robust logging services
4 | extends: _layouts.documentation
5 | section: content
6 | ---
7 |
8 | # Logging
9 |
10 | Using the `app:install` Artisan command you can install the `log` component:
11 | ```bash
12 | php 
45 |
46 | Changing the appearance
47 | 48 | The appearance of the menu can be set with a fluent API. What if we like 49 | a green font on a black background? The code below shows you how to do just that and some extras. 50 | 51 | ```php 52 | $this->menu($title, $options) 53 | ->setForegroundColour('green') 54 | ->setBackgroundColour('black') 55 | ->setWidth(200) 56 | ->setPadding(10) 57 | ->setMargin(5) 58 | ->setExitButtonText("Abort") 59 | // remove exit button with 60 | // ->disableDefaultItems() 61 | ->setUnselectedMarker('❅') 62 | ->setSelectedMarker('✏') 63 | ->setTitleSeparator('*-') 64 | ->addLineBreak('<3', 2) 65 | ->addStaticItem('AREA 2') 66 | ->open(); 67 | ``` 68 | 69 | > Behind the scenes, the `menu` method uses the 70 | [`nunomaduro/laravel-console-menu`](https://github.com/nunomaduro/laravel-console-menu) 71 | package. You can find more details on how to use the menu method there. 72 | -------------------------------------------------------------------------------- /source/docs/contributing.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Contributing 3 | description: How to contribute 4 | extends: _layouts.documentation 5 | section: content 6 | --- 7 | 8 | # Contributing 9 | 10 | Everything that we make is 100% open source and developed collaboratively by people from all over the world. Even if you're not a programmer, you can get involved and make a difference. 11 | 12 | #### Code 13 | 14 | You may propose new features or improvements of existing Laravel Zero behavior. If you propose a new feature, please be willing to implement at least some of the code that would be needed to complete the feature. 15 | 16 | The Laravel Zero source code is managed on GitHub, and there are repositories for each of the Laravel Zero projects: 17 | 18 | - [Laravel Zero Application](https://github.com/laravel-zero/laravel-zero) 19 | - [Laravel Zero Framework](https://github.com/laravel-zero/framework) 20 | - [Laravel Zero Installer](https://github.com/laravel-zero/installer) 21 | - [Laravel Zero Website](https://github.com/laravel-zero/website) 22 | - [Collision](https://github.com/nunomaduro/collision) 23 | 24 | All the contribution guidelines are mentioned [here](https://github.com/laravel-zero/laravel-zero/blob/master/CONTRIBUTING.md). 25 | 26 | You can have a look at the [CHANGELOG](https://github.com/laravel-zero/laravel-zero/blob/master/CHANGELOG.md) for constant updates & detailed information about the changes. You can also follow the twitter account for latest announcements : [@enunomaduro](https://twitter.com/enunomaduro) 27 | 28 | #### Funding 29 | 30 | My name is Nuno Maduro and I am the creator and maintainer of tools such as Laravel Zero, Collision, etc. 31 | 32 | All my work has always been released under the Open Source license MIT, and this will continue into the far future. It has cost me thousands of hours to develop, test and support Laravel Zero, Collision, etc. 33 | 34 | If you find the work I do for the PHP community valuable then you can show your appreciation by supporting me here on Patreon or Paypal. 35 | 36 | The support will be used to create new features and everything related to make the console development the most enjoyable as possible. 37 | 38 | - PayPal: [Donate](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=66BYDWAT92N6L) 39 | - Patreon: [Donate](https://www.patreon.com/nunomaduro) 40 | - Open Collective: [Donate](https://opencollective.com/laravel-zero) 41 | 42 | #### License 43 | 44 | Laravel Zero is an open-source software licensed under the MIT license. 45 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 | 
3 |
6 | 
7 | 
8 | 
9 | 
10 | 
11 |
This is a community project and not an official Laravel one
14 |
15 | Laravel Zero was created by, and is maintained by [Nuno Maduro](https://github.com/nunomaduro), and is a micro-framework that provides an elegant starting point for your console application. It is an **unofficial** and customized version of Laravel optimized for building command-line applications.
16 |
17 | - Built on top of the [Laravel](https://laravel.com) components.
18 | - Optional installation of Laravel [Eloquent](/source/docs/database.md), Laravel [Logging](/source/docs/logging.md) and many others.
19 | - Supports interactive [menus](/source/docs/build-interactive-menus.md) and [desktop notifications](/source/docs/send-desktop-notifications.md) on Linux, Windows & MacOS.
20 | - Ships with a [Scheduler](/source/docs/task-scheduling.md) and a [Standalone Compiler](/source/docs/build-a-standalone-application.md).
21 | - Integration with [Collision](https://github.com/nunomaduro/collision) - Beautiful error reporting
22 |
23 | ------
24 |
25 | ## Getting started
26 |
27 | * [Installation](/source/docs/installation.md)
28 | * [Upgrade](/source/docs/upgrade.md)
29 | * [Usage](/source/docs/commands.md)
30 | * [Contributing](/source/docs/contributing.md)
31 |
32 | ------
33 |
34 | ## Support the development
35 | **Do you like this project? Support it by donating:**
36 |
37 | - PayPal: [Donate](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=66BYDWAT92N6L)
38 | - Patreon: [Donate](https://www.patreon.com/nunomaduro)
39 |
--------------------------------------------------------------------------------
/source/assets/img/logo.svg:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/source/docs/commands.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Commands
3 | description: The `App\Commands` folder
4 | extends: _layouts.documentation
5 | section: content
6 | ---
7 |
8 | # Commands
9 |
10 | The `App\Commands` folder should contain your application Artisan commands. By default,
11 | it brings the `app\Commands\InspiringCommand.php` as example command:
12 | ```php
13 | namespace App\Commands;
14 |
15 | use Illuminate\Console\Scheduling\Schedule;
16 | use LaravelZero\Framework\Commands\Command;
17 |
18 | class InspiringCommand extends Command
19 | {
20 | /**
21 | * The signature of the command.
22 | *
23 | * @var string
24 | */
25 | protected $signature = 'inspiring {name=Artisan}';
26 |
27 | /**
28 | * The description of the command.
29 | *
30 | * @var string
31 | */
32 | protected $description = 'Display an inspiring quote';
33 |
34 | /**
35 | * Execute the console command.
36 | *
37 | * @return mixed
38 | */
39 | public function handle()
40 | {
41 | $this->info('Simplicity is the ultimate sophistication.');
42 | }
43 |
44 | /**
45 | * Define the command's schedule.
46 | *
47 | * @param \Illuminate\Console\Scheduling\Schedule $schedule
48 | * @return void
49 | */
50 | public function schedule(Schedule $schedule)
51 | {
52 | // $schedule->command(static::class)->everyMinute();
53 | }
54 | }
55 | ```
56 |
57 | Of course, you can always create a new command using the `make:command` Artisan command:
58 | ```bash
59 | php
6 |
41 |
42 |
7 |
36 |
37 | 8 | {{ $page->siteName }} 9 |
10 | 11 |15 | {{ $page->siteDescription }} 16 |
17 | 18 |
19 |
23 | Get Started
24 |
25 |
26 |
32 | View on Github
33 |
34 |
35 |
38 | 
39 |
40 |
39 | 43 | 44 |
45 |
81 |
46 | 
47 |
48 |
49 | Highly modular
51 |
52 |
56 |
57 |
47 |
48 |
49 | Highly modular
Framework design
50 |
51 |
52 | 53 | Laravel Zero is a lightweight and modular micro-framework for developing fast and powerful console applications. Built on top of the Laravel components. 54 |
55 |
58 | 
59 |
60 |
61 | Write powerful
63 |
64 |
68 |
69 |
59 |
60 |
61 | Write powerful
Console applications
62 |
63 |
64 | 65 | Laravel Zero has a simple and powerful syntax that enables developers to build very complex applications far more quickly than with any previous framework. 66 |
67 |
70 | 
71 |
72 |
73 | For Artisans
75 |
76 |
80 |
71 |
72 |
73 | For Artisans
100% Open Source
74 |
75 |
76 | 77 | You’re free to dig through the source to see exactly how it works. See something that needs to be improved? Just send us a pull request on GitHub. 78 |
79 |
51 |
65 |
52 |
53 | 
54 |
55 |
56 |
57 |
54 |
55 |
58 | @if ($page->docsearchApiKey && $page->docsearchIndexName)
59 | @include('_nav.search-input')
60 | @endif
61 |
62 |
63 | @yield('nav-toggle')
64 |