A bookmarkable, searchable cheatsheet for all of Laravel's default Artisan commands.

Related tags

Laravel artisan.page
Overview

artisan.page

A bookmarkable, searchable cheatsheet for all of Laravel's default Artisan commands.

Generation

The generation of the manifest files is done via the build script.

Build Setup

# install dependencies
$ npm install

# serve with hot reload at localhost:3000
$ npm run dev

# build for production and launch server
$ npm run build
$ npm run start

# generate static project
$ npm run generate

Credits

License

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

Comments
  • Feature/automate build process

    Feature/automate build process

    Hey, so this this works pretty well but some things to note:

    • The GH action workflow will re-commit changes after it generates the commands list. This sometimes (well, many times) creates a race condition situation. I added a retry but maybe you have a better approach. Might also be good enough as-is though, as you can just re-run the job if needed and it should work. ie. It won't break anything.

    • The packages and versions are updated in the manifest file.

    • I left the styling for you but added some sensible defaults.

    • The packages don't install on anything below 8.x as it would require some logic to reconcile the version numbers. Composer throws dependency requirement error, but it won't crash the workflow. Probably not worth adding support?

    Feel free to take ever the PR of course, but if there's anything you want me to tweak let me know. And of course if you hate it, no need to merge it ha ha. It seems like a lot of work but I took it on to practice a complex GH action workflow, so it time well spent regardless!

    https://user-images.githubusercontent.com/1478421/105506846-1264a880-5cfd-11eb-87f8-2bcb3fb18d4b.mp4

    opened by KevinBatdorf 16
  • Added dark mode

    Added dark mode

    Hey James! 😄

    This PR adds a dark mode to the site. I'm by no means a designer so you might not be happy with the changes I've made, but hopefully, it can at least provide a good starting point. I've also not got too much experience with Nuxt so there's a possibility that some of the stuff I've done can be done much better.

    I also couldn't get npm run dev to run because I kept getting this error:

    Error: Cannot find module 'tailwindcss/defaultTheme'
    

    Running npm install tailwindcss seemed to fix it. I don't know if this was an issue with the repo or just something on my end that I wasn't doing right? But if it needs removing again from the package.json, I'll make sure to revert that back.

    I've attached some images to give you a comparison of the light and dark modes. Hopefully, you're happy with the general approach. If this is something that you might consider merging but you want some changes making first, let me know and I'll do them ASAP :)

    darkmode lightmode
    opened by ash-jc-allen 6
  • Feature - Allow for search via URL query

    Feature - Allow for search via URL query

    In order to quickly use documentation provided by artisan.page via external sources like Alfred, it would be great if a search could be made through the query params. This commit will allow a user to find documentation by adding ?search={query} to the URL and actually making a search. The value of the search field will then be populated by the query param.

    Thank you for your consideration.

    opened by MFlor 5
  • Add clipboard copy module

    Add clipboard copy module

    Wanted to write some Vue code and saw someone request this on twitter so I figured why not. Let me know if I missed something!

    https://user-images.githubusercontent.com/1478421/105005995-9fdb9a80-5a68-11eb-9e8f-41d691e0e3f5.mp4

    opened by KevinBatdorf 4
  • Monitor package updates with dependabot

    Monitor package updates with dependabot

    For an enhancement if #9 merges in, you could remove the manifest file and add a composer.json file, and set up dependabot to auto run the build process when a package makes a release (I think dependabot triggers action, but not 100% sure). That way you won't have to monitor any changes, and only need to update the supported packages/ laravel versions as needed.

    It might also help the build run faster as I don't think composer is currently being cached since there is no lock file.

    I'm happy to implement this if you'd like. Would be good practice for me.

    opened by KevinBatdorf 3
  • Smooth scrolling & navbar counts

    Smooth scrolling & navbar counts

    Hey @jbrooksuk! This is just a small PR that makes a couple of tiny changes.

    The first change I've made is enabling smooth scrolling across the entire page. My thinking behind this is that it will make the page feel smoother when clicking on the links in the side navbar (and match the smooth scroll behaviour of the "back to top" button).

    The second change I've made is to add some counts to the navbar groups (like in the screenshots below). My thinking behind this is that it could make it easier for people to spot when new commands have been added to the framework. I like this feature because I'm a bit of a sucker for counts/numbers everywhere and they help me to visualise things, but that might not be the same for everyone else haha!

    If you think these are worth merging, feel free to give me a shout if anything needs changing. If you'd prefer not to merge them though, that's totally cool! 😄

    Screenshot 2022-11-24 at 10 39 35 Screenshot 2022-11-24 at 10 39 48 Screenshot 2022-11-24 at 10 39 24
    opened by ash-jc-allen 2
  • Command List

    Command List

    Hey James!

    This PR adds a list of the commands to the left-hand side of the page in the desktop view. I thought it'd be a pretty nice way of being able to quickly view the available commands.

    I've taken the same sort of approach with how php artisan would work if you ran it in your console (like in the screenshot). So, the 'ungrouped' commands that don't have a prefix before : will be placed at the top of the list. Any after that will then be grouped by their prefix.

    Each of the commands on the left-hand side take you straight you to the command info when clicked on, so it acts as a form of navigation.

    I've not added anything for the mobile view because I thought it might just get in the way more than anything. If you think a mobile list would be useful though, I'd be happy to get one added.

    By the way, I'm by no means a JS developer, so if there's anything that I've done that looks a bit odd, I apologise in advance haha!

    Hopefully it's something that you'll consider pulling in, but if you do need any changes making for it, please let me know 😄

    Screenshot 2021-11-15 at 22 44 35 Screenshot 2021-11-15 at 22 46 47
    opened by ash-jc-allen 1
  • Add ESLint config

    Add ESLint config

    I added a basic config for eslint. If you want, I can probably automate it to auto fix on pre-commit or something like that (so you don't have to rely on the editor)

    opened by KevinBatdorf 1
  • Update the favicon to use the official Laravel one.

    Update the favicon to use the official Laravel one.

    Not sure if you left it for later or if you wanted to avoid using the official one.

    I think it's better than the default Nuxt one for now anyway ¯_(ツ)_/¯

    opened by clemblanco 1
  • Use keyword to filter the commands list

    Use keyword to filter the commands list

    If you look for "Cache" you will get the command "optimize" as it has "Cache" in its description instead of "cache:clear" that has "cache" in the title.

    opened by gabbanaesteban 1
  • Fix search in mobile

    Fix search in mobile

    In mobiles (using Gboard, and some other keyboards) the v-model does not work until you hide the keyboard.

    Here is a comment from Evan You: https://github.com/vuejs/vue/issues/9777#issuecomment-478831263

    opened by gabbanaesteban 0
  • Add server api endpoint

    Add server api endpoint

    Hey James, this PR adds an api endpoint to query the docs. I also upgraded Nuxt 2 to Nuxt bridge, which essentially adds v3 features to v2.

    Files changed followed the migration guide here: https://v3.nuxtjs.org/bridge/overview

    I've only tested this locally so far so there could be further cors setup required.

    List all commands:

    GET /api
    

    Search for a command:

    GET /api?s=database
    

    Specify a version:

    GET /api?v=8.x
    

    closes #25

    opened by KevinBatdorf 9
  • Add api endpoints

    Add api endpoints

    Have you though about adding api endpoints that show available commands and descriptions?

    I think if you upgrade to nuxt 3 it's built in (maybe even in nuxt 2, I just don't know).

    https://v3.nuxtjs.org/guide/features/server-routes

    It could then be consumed by something like Alfred or Raycast. I wrote a Forge Raycast extension and was thinking to show available artisan commands by Laravel version that can execute via the site command endpoint.

    I thought about getting the commands from the server like the build command here does, but that might be too intrusive, while an API would be perfect (or I do both and have the former be opt in).

    opened by KevinBatdorf 2
Owner
James Brooks
Software Developer @laravel
James Brooks
Adds a way to write php and run it directly in Laravels' Artisan Tinker.

Adds a way to write php in PhpStorm/IDEA and run it directly as if through laravel artisan tinker - allowing you to quickly run a piece of code with a

Robbin 120 Jan 2, 2023
Textpattern-default-theme - Textpattern CMS default theme.

Textpattern CMS default theme This project is the source for the default theme that ships as standard with Textpattern CMS. It is intended as a starti

Textpattern CMS 61 Nov 21, 2022
Composer package which adds support for HTML5 elements using Laravels Form interface (e.g. Form::date())

Laravel HTML 5 Inputs Composer package which adds support for HTML5 elements by extending Laravel's Form interface (e.g. Form::date()) Adds support fo

Small Dog Studios 11 Oct 13, 2020
Livewire component for dependant and/or searchable select inputs

Livewire Select Livewire component for dependant and/or searchable select inputs Preview Installation You can install the package via composer: compos

Andrés Santibáñez 441 Dec 19, 2022
📝 Artisan Menu - Use Artisan via an elegant console GUI

?? Artisan Menu Use Artisan via an elegant console GUI Features Run built-in and custom Artisan commands from a console GUI Prompts to enter required

Jordan Hall 149 Dec 29, 2022
📝 Artisan Menu - Use Artisan via an elegant console GUI

?? Artisan Menu Use Artisan via an elegant console GUI Features Run built-in and custom Artisan commands from a console GUI Prompts to enter required

Jordan Hall 148 Nov 29, 2022
A package that makes it easy to have the `artisan make:` commands open the newly created file in your editor of choice.

Open On Make A package that makes it easy to have the artisan make: commands open the newly created file in your editor of choice. Installation compos

Andrew Huggins 94 Nov 22, 2022
Package for Laravel that gives artisan commands to setup and edit environment files.

Setup and work with .env files in Laravel from the command line NOTE: This doesn't work with Laravel 5 since .env files were changed. This is for Lara

Matt Brunt 6 Dec 17, 2022
Laravel API architecture builder based on artisan commands.

??‍?? API-Formula Laravel API architecture builder based on artisan commands. This package provides a nice and fluent way to generate combined control

Krševan Lisica 1 Jan 16, 2022
This Laravel Nova tool lets you run artisan and bash commands directly from Nova 4 or higher.

Laravel Nova tool for running Artisan & Shell commands. This Nova tool lets you run artisan and bash commands directly from nova. This is an extended

Artem Stepanenko 17 Dec 15, 2022
Execute Laravel Artisan commands via REST APIs and HTTP requests safely.

Artisan Api There might be some times you wanted to execute an Artisan command, but you did not have access to shell or SSH. Here we brought REST API

Alireza 11 Sep 7, 2022
This tool gives you the ability to set the default collapse state for Nova 4.0 menu items.

Nova Menu Collapsed This tool gives you the ability to set the default collapse state for Nova 4.0 menu items. Requirements php: >=8.0 laravel/nova: ^

Artem Stepanenko 10 Nov 17, 2022
👀 Manage your views in Laravel projects through artisan

Artisan View This package adds a handful of view-related commands to Artisan in your Laravel project. Generate blade files that extend other views, sc

Sven Luijten 842 Dec 29, 2022
Dispatch Laravel jobs via Artisan

This package can register jobs as Artisan commands. All you need to do is let your job implement the empty ArtisanDispatchable interface.

Spatie 135 Nov 7, 2022
📦 Adds Laravel Packages Support to Lumen and Vendor Publish Artisan Command.

Laravel Package Support for Lumen: Makes Lumen compatible with Laravel Packages. You can use any Laravel Packages in Lumen by installing Larasupport Package.

Irfaq Syed 127 Dec 17, 2022
Create Laravel views (blade template) using 'php artisan' command-line interface

About LaraBit Have you ever wonder to create Laravel views (Blade Templates) using the same type of artisan commands that you usually use to create ne

Ragib MRB 5 Oct 15, 2021
Generate services in Laravel with the artisan command

Laravel Service Generator Quickly generate services for your projects! Table of Contents Features Installation Usage Generate services Generate servic

Tim Wassenburg 15 Dec 2, 2022
A Laravel Artisan SQL Interactive Interface

sqli A Laravel 4 & 5 Artisan SQL Interactive Interface, plus a handful of Artisan commands to execute SQL queries. sqli It's like tinker for SQL, just

Antonio Carlos Ribeiro 61 Apr 18, 2022
This package provides you with a simplistic `php artisan make:user` command

Laracademy Generators Laracademy make:user Command - provides you with a simplistic artisan command to generate users from the console. Author(s): Lar

Laracademy 18 Jan 19, 2019