{"id":18478213,"url":"https://github.com/tighten/lambo","last_synced_at":"2025-10-07T04:24:23.212Z","repository":{"id":42636262,"uuid":"63549570","full_name":"tighten/lambo","owner":"tighten","description":"Quick new application creation with Laravel and Valet","archived":false,"fork":false,"pushed_at":"2023-08-08T03:18:07.000Z","size":39615,"stargazers_count":611,"open_issues_count":12,"forks_count":52,"subscribers_count":20,"default_branch":"main","last_synced_at":"2025-04-02T06:15:44.385Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tighten.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.TXT","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-07-17T19:48:34.000Z","updated_at":"2025-02-07T11:23:50.000Z","dependencies_parsed_at":"2024-06-27T05:41:20.010Z","dependency_job_id":"10d432fb-a5d8-43ca-b040-ca2a9526e63c","html_url":"https://github.com/tighten/lambo","commit_stats":{"total_commits":558,"total_committers":35,"mean_commits":"15.942857142857143","dds":0.3709677419354839,"last_synced_commit":"80a768e13e245a682f60f3fa5676bf92bf64754a"},"previous_names":[],"tags_count":60,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tighten%2Flambo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tighten%2Flambo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tighten%2Flambo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tighten%2Flambo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tighten","download_url":"https://codeload.github.com/tighten/lambo/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247767232,"owners_count":20992538,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest"],"created_at":"2024-11-06T12:09:15.870Z","updated_at":"2025-10-07T04:24:18.163Z","avatar_url":"https://github.com/tighten.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Lambo logo](https://raw.githubusercontent.com/tighten/lambo/main/lambo-banner.png)\n\n[![Run tests](https://github.com/tighten/takeout/workflows/Run%20tests/badge.svg?branch=main)](https://github.com/tighten/lambo/actions?query=workflow%3A%22Run+Tests%22)\n\n**Super-powered `laravel new` for Laravel and Valet**\n\nLambo is a command-line tool that replaces the Laravel installer and wraps up the most common tasks you might take when creating a Laravel app: opening it in your editor and your browser, initialize a git repository, tweak your `.env` and `.env.example`, and more.\n\n\n# Requirements\n\n- PHP 7.3+\n- (optional, but beneficial) [Laravel Valet](https://laravel.com/docs/valet)\n\n# Installation\n\n```bash\ncomposer global require tightenco/lambo:^3.0\n```\n\n# Upgrading\n\n```bash\ncomposer global update tightenco/lambo\n```\n\n# Usage\n\nMake sure `~/.composer/vendor/bin` is in your terminal's path.\n\n```bash\ncd ~/Sites\nlambo new myNextProject\n```\n\n# What exactly does it do?\n\n- `laravel new $PROJECTNAME`\n- Initialize a git repo, add all the files, and, after some changes below, make a commit with the text \"Initial commit.\"\n- Replace the `.env` (and `.env.example`) database credentials with the default macOS MySQL credentials: database of `$PROJECTNAME`, user `root`, and empty password\n- Replace the `.env` (and `.env.example`) `APP_URL` with `$PROJECTNAME.$YOURVALETTLD`\n- Generate an app key\n- Open the project in your favorite editor\n- Open `$PROJECTNAME.$YOURVALETTLD` in your browser\n\n\u003e Note: If your `$PROJECTNAME` has dashes (`-`) in it, they will be replaced with underscores (`_`) in the database name.\n\nThere are also a few optional behaviors based on the parameters you pass (or define in your config file), including creating a database, migrating, installing Jetstream, running Valet Link and/or Secure, and running a custom bash script of your definition after the fact.\n\n# Customizing Lambo\n\nWhile the default actions Lambo provides are great, most users will want to customize at least a few of the steps. Thankfully, Lambo is built to be customized!\n\nThere are three ways to customize your usage of Lambo: command-line arguments, a config file, and an \"after\" file.\n\nMost users will want to set their preferred configuration options once and then never think about it again. That's best solved by creating a config file.\n\nBut if you find yourself needing to change the way you interact with Lambo on a project-by-project basis, you may also want to use the command-line parameters to customize Lambo when you're using it.\n\n## Creating a config file\n\nYou can create a config file at `~/.lambo/config` rather than pass the same arguments each time you create a new project.\n\nThe following command creates the file, if it doesn't exist, and edits it:\n\n```bash\nlambo edit-config\n```\n\nThe config file contains the configuration parameters you can customize, and will be read on every usage of Lambo.\n\n## Creating an \"after\" file\n\nYou can also create an after file at `~/.lambo/after` to run additional commands after you create a new project.\n\nThe following command creates the file, if it doesn't exist, and edits it:\n\n```bash\nlambo edit-after\n```\n\nThe after file is interpreted as a bash script, so you can include any commands here, such as installing additional composer dependencies...\n\n```bash\n# Install additional composer dependencies as you would from the command line.\necho \"Installing Composer Dependencies\"\ncomposer require tightenco/mailthief tightenco/quicksand\n```\n\n...or copying additional files to your new project.\n\n```bash\n# To copy standard files to new lambo project place them in ~/.lambo/includes directory.\necho \"Copying Include Files\"\ncp -R ~/.lambo/includes/ $PROJECTPATH\n```\n\nYou also have access to variables from your config file such as `$PROJECTPATH` and `$CODEEDITOR`.\n\n## Using command-line parameters\n\nAny command-line parameters passed in will override Lambo's defaults and your config settings. See a [full list of the parameters you can pass in](#parameters).\n\n# Lambo Commands\n\n- `help` or `help-screen` show the help screen\n\n\u003ca id=\"config-files\"\u003e\u003c/a\u003e\n- `edit-config` edits your config file (and creates one if it doesn't exist)\n\n  ```bash\n  lambo edit-config\n  ```\n\n- `edit-after` edits your \"after\" file (and creates one if it doesn't exist)\n\n  ```bash\n  lambo edit-after\n  ```\n\n\n\u003ca id=\"parameters\"\u003e\u003c/a\u003e\n# Configurable parameters\n\nYou can optionally pass one or more of these parameters every time you use Lambo. If you find yourself wanting to configure any of these settings every time you run Lambo, that's a perfect use for the [config files](#config-files).\n\n- `-e` or `--editor` to define your editor command. Whatever is passed here will be run as `$EDITOR .` after creating the project.\n\n  ```bash\n  # runs \"subl .\" in the project directory after creating the project\n  lambo new superApplication --editor=subl\n  ```\n\n- `-p` or `--path` to specify where to install the application.\n\n  ```bash\n  lambo new superApplication --path=~/Sites\n  ```\n\n- `-m` or `--message` to set the first Git commit message.\n\n  ```bash\n  lambo new superApplication --message=\"This lambo runs fast!\"\n  ```\n\n- `-f` or `--force` to force install even if the directory already exists \n\n  ```bash\n  # Creates a new Laravel application after deleting ~/Sites/superApplication  \n  lambo new superApplication --force\n  ```\n  \n- `-d` or `--dev` to choose the `develop` branch instead of `master`, getting the beta install.\n\n  ```bash\n  lambo new superApplication --dev\n  ```\n\n- `-b` or `--browser` to define which browser you want to open the project in.\n\n  ```bash\n  lambo new superApplication --browser=\"/Applications/Google Chrome Canary.app\"\n  ```\n\n- `-l` or `--link` to create a Valet link to the project directory.\n\n  ```bash\n  lambo new superApplication --link\n  ```\n\n- `-s` or `--secure` to secure the Valet site using https.\n\n  ```bash\n  lambo new superApplication --secure\n  ```\n\n- `--create-db` to create a new MySQL database which has the same name as your project.\n  This requires `mysql` command to be available on your system.\n\n  ```bash\n  lambo new superApplication --create-db\n  ```\n\n- `--migrate-db` to migrate your database.\n\n  ```bash\n  lambo new superApplication --migrate-db\n  ```\n\n- `--dbuser` to specify the database username.\n\n  ```bash\n  lambo new superApplication --dbuser=USER\n  ```\n\n- `--dbpassword` specify the database password.\n\n  ```bash\n  lambo new superApplication --dbpassword=SECRET\n  ```\n\n- `--dbhost` specify the database host.\n\n  ```bash\n  lambo new superApplication --dbhost=127.0.0.1\n  ```\n\n- `--breeze=STACK` to use the Laravel Breeze starter kit. `STACK` may be either `blade`, `vue` or `react`.\n\n  ```bash\n  lambo new superApplication --breeze=blade\n  lambo new superApplication --breeze=vue\n  lambo new superApplication --breeze=react\n  ```\n\n- `--jetstream=STACK[,teams]` to use the Laravel Jetstream starter kit. `STACK` may be either `inertia` or `livewire`.\n\n  ```bash\n  lambo new superApplication --jetstream=inertia\n  lambo new superApplication --jetstream=inertia,teams\n  lambo new superApplication --jetstream=livewire\n  lambo new superApplication --jetstream=livewire,teams\n  ```\n  \n- `--full` to use `--create-db`, `--migrate-db`, `--link`, and `-secure`.\n\n  ```bash\n  lambo new superApplication --full\n\n**GitHub Repository Creation**\n\n**Important:** To create new repositories Lambo requires one of the following tools to be installed:\n- the official [GitHub command line tool](https://github.com/cli/cli#installation)\n- the [hub command line tool](https://github.com/github/hub#installation)\n \nLambo will give you the option to continue without GitHub repository creation if neither tool is installed.\n\n- `-g` or `--github` to  Initialize a new private GitHub repository and push your new project to it.\n\n```bash\n# Repository created at https://github.com/\u003cyour_github_username\u003e/superApplication\nlambo new superApplication --github\n```\n\n- Use `--gh-public` with `--github` to make the new GitHub repository public.\n\n```bash\nlambo new superApplication --github --gh-public\n```\n\n- Use `--gh-description` with `--github` to initialize the new GitHub repository with a description.\n\n```bash\nlambo new superApplication --github --gh-description='My super application'\n```\n- Use `--gh-homepage` with `--github` to initialize the new GitHub repository with a homepage url. \n\n```bash\nlambo new superApplication --github --gh-homepage=https://example.com\n```\n- Use `--gh-org` with `--github` to initialize the new GitHub repository with a specified organization.\n\n```bash\n# Repository created at https://github.com/acme/superApplication\nlambo new superApplication --github --gh-org=acme\n```\n\n-----\n\n# For contributors:\n\n## Process for release\n\nIf you're working with us and are assigned to push a release, here's the easiest process:\n\n1. Visit the [Lambo Releases page](https://github.com/tighten/lambo/releases); figure out what your next tag will be (increase the third number if it's a patch or fix; increase the second number if it's adding features)\n2. On your local machine, pull down the latest version of `main` (`git checkout main \u0026\u0026 git pull`)\n3. Build for the version you're targeting (`./lambo app:build`)\n4. Run the build once to make sure it works (`./builds/lambo`)\n5. Commit your build and push it up\n6. [Draft a new release](https://github.com/tighten/lambo/releases/new) with both the tag version and release title of your tag (e.g. `v1.5.1`)\n7. Set the body to be a bullet-point list with simple descriptions for each of the PRs merged, as well as the PR link in parentheses at the end. For example:\n\n    `- Add a superpower (#92)`\n8. Hit `Publish release`\n9. Profit\n\n## Notes for future development\n\n- All new configuration keys must be added to the `$newConfiguration` property in `UpgradeSavedConfiguration`\n- All removed or deprecated configuration keys must be added to the `$removedConfigurationKeys` property in `UpgradeSavedConfiguration`\n- Any time configuration keys are changed, the `$configurationVersion` property in `UpgradeSavedConfiguration` needs to be incremented\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftighten%2Flambo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftighten%2Flambo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftighten%2Flambo/lists"}