{"id":21753712,"url":"https://github.com/includable/craftup","last_synced_at":"2025-08-01T09:34:15.431Z","repository":{"id":37529255,"uuid":"173383759","full_name":"includable/craftup","owner":"includable","description":"👔 Manage your Craft CMS development workflow from the command line.","archived":false,"fork":false,"pushed_at":"2024-11-06T20:20:32.000Z","size":3094,"stargazers_count":5,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-19T19:03:47.703Z","etag":null,"topics":["cli","craft","craftcms"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/includable.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2019-03-02T00:03:32.000Z","updated_at":"2024-12-18T11:57:19.000Z","dependencies_parsed_at":"2023-07-25T14:30:42.713Z","dependency_job_id":"badeed4d-9b6b-4e1e-9fb9-4f046f9fb6b0","html_url":"https://github.com/includable/craftup","commit_stats":null,"previous_names":["tschoffelen/craftup"],"tags_count":20,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/includable%2Fcraftup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/includable%2Fcraftup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/includable%2Fcraftup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/includable%2Fcraftup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/includable","download_url":"https://codeload.github.com/includable/craftup/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235648140,"owners_count":19023608,"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":["cli","craft","craftcms"],"created_at":"2024-11-26T09:11:00.840Z","updated_at":"2025-01-25T23:35:12.424Z","avatar_url":"https://github.com/includable.png","language":"JavaScript","readme":"# craftup\n\n**The easiest way to develop Craft CMS websites.**\n\n## Introduction\n\nThe goal of `craftup` is twofold:\n\n#### Make it super easy to start your next Craft CMS project.\n\nWe do this by providing a single `craftup init` command which sets up a project scaffold based on the Craft CMS starter\ntemplate, with some improvements. It also sets up all the configuration files required to run this new site in Docker,\nso that you don't need to install Apache, PHP and MySQL locally.\n\n#### Make deployments painless.\n\nIf you haven't already set up continuous integration for your project, deploying usually means copying files over via\nFTP, manually exporting your local database and then re-importing that data in the production database. We simplify that\nby providing the `craftup pull` and `craftup push` commands, which automate every step of this process.\n\nAs a bonus, having a single CLI command that performs the whole deployment makes setting up continuous integration a lot\neasier!\n\n## Installation\n\nMake sure you have a recent version of [Node](http://nodejs.org/) (8+) installed. If you plan to develop locally, you\nwill also need to install [Docker](https://docker.com).\n\nAfter making sure those dependencies are met, installing `craftup` is as simple as running this command:\n\n```shell\nnpm i -g craftup\n```\n\nVerify your install by running `craftup -v`.\n\n## Starting your project\n\n### Init a project\n\nTo start a new project, run:\n\n```shell\ncraftup init \u003cprojectname\u003e\n```\n\nThis will create a new directory that contains a clean Craft CMS project.\n\n### Start local server\n\nFrom there, you can start your local development server by changing into the newly created\ndirectory (`cd \u003cprojectname\u003e`) and running:\n\n```shell\ncraftup start\n```\n\nThis might take a while the first time, since it needs to download the appropriate Docker images to run the project.\nSubsequent runs will be much, much faster.\n\n## Tools during development\n\n### Install a dependency\n\nUse the built-in `composer` command to install a composer package:\n\n```shell\ncraftup composer craftcms/aws-s3\n```\n\nThis is the same as running `composer require craftcms/aws-s3`. It is run within the Docker container however, meaning\nthat you don't need to have Composer installed on your machine.\n\n### Dump the database\n\nDuring development you might want to export your database contents. You can do so from within the Craft dashboard, but\nalso by running:\n\n```shell\ncraftup dump [path]\n```\n\nIf you don't specify a path, this will create a file called `database.sql` in your root project directory.\n\nWarning: this will overwrite any existing files with the same filename.\n\n## Default template\n\nThe default template contains these plugins pre-installed:\n\n- Redactor - the rich text editor of choice in Craft\n- AWS S3 - an easy way to store assets in the cloud\n- [SEO](https://github.com/ethercreative/seo#readme) - a simple SEO plugin from Ethercreative\n\n## Project status\n\n[![Travis](https://img.shields.io/travis/com/tschoffelen/craftup.svg)](https://travis-ci.com/tschoffelen/craftup)\n[![npm](https://img.shields.io/npm/v/craftup.svg)](https://npmjs.com/package/craftup)\n\nThis project is in beta status. Our team has been using it internally for dozens of projects, but there's still a lot to\ndo, especially for non-Mac users.\n\n- [x] Create and run new projects with `init` and `start` commands\n- [x] Import and export database with `load` and `dump` commands\n- [ ] Add FTP support for `push` and `pull` commands\n- [ ] Add SSH support for `push` and `pull` commands\n- [ ] Add support for Windows and Linux\n\nPlease do feel free to help out by submitting pull requests and opening issues.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fincludable%2Fcraftup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fincludable%2Fcraftup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fincludable%2Fcraftup/lists"}