Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/statamic/cli
Install and manage your Statamic projects from the command line.
https://github.com/statamic/cli
cli installer statamic
Last synced: 6 days ago
JSON representation
Install and manage your Statamic projects from the command line.
- Host: GitHub
- URL: https://github.com/statamic/cli
- Owner: statamic
- Created: 2017-06-26T02:08:08.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T14:46:26.000Z (about 2 months ago)
- Last Synced: 2024-12-09T00:05:48.505Z (13 days ago)
- Topics: cli, installer, statamic
- Language: PHP
- Homepage:
- Size: 127 KB
- Stars: 72
- Watchers: 12
- Forks: 18
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome - Statamic CLI - Install and manage Statamic from the command line (Dev Tools)
README
# Statamic CLI Tool
🌴 Install and manage your **Statamic** projects from the command line.
- [Installing the CLI tool](#installing-the-cli-tool)
- [Using the CLI tool](#using-the-cli-tool)
- [Installing Statamic](#installing-statamic)
- [Checking Statamic versions](#checking-statamic-versions)
- [Updating Statamic](#updating-statamic)
## Installing the CLI tool
```
composer global require statamic/cli
```
Make sure to place Composer's system-wide vendor bin directory in your `$PATH` so the `statamic` executable can be located by your system. [Here's how](https://statamic.dev/troubleshooting/command-not-found-statamic).
Once installed, you should be able to run `statamic {command name}` from within any directory.
### GitHub authentication
When you install starter kits, the CLI might present you with a warning that the GitHub API limit is reached. [Generate a Personal access token](https://github.com/settings/tokens/new) and paste it in your terminal with this command so Composer will save it for future use:
```bash
composer config --global --auth github-oauth.github.com [your_token_here]
```
Read more on this in the [Composer Docs](https://getcomposer.org/doc/articles/authentication-for-private-packages.md).
## Updating the CLI tool
```
composer global update statamic/cli
```
Run this command to update the CLI tool to the most recent published version. If there's been a major version release, you may need to run `require` instead of update.
## Using the CLI tool
### Installing Statamic
You may create a new Statamic site with the `new` command:
```
statamic new my-site
```
This will present you with a list of supported starter kits to select from. Upon selection, the latest version will be downloaded and installed into the `my-site` directory.
You may also pass an explicit starter kit repo if you wish to skip the selection prompt:
```
statamic new my-site statamic/starter-kit-cool-writings
```
### Checking Statamic versions
From within an existing Statamic project root directory, you may run the following command to quickly find out which version is being used.
```
statamic version
```
### Updating Statamic
From within an existing Statamic project root directory, you may use the following command to update to the latest version.
```
statamic update
```
This is just syntactic sugar for the `composer update statamic/cms --with-dependencies` command.