Coder Social home page Coder Social logo

statamic-cli's Introduction

Statamic CLI Tool

Statamic 3.0+

๐ŸŒด Install and manage your Statamic projects from the command line.

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.

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 acces token and paste it in your terminal with this command so Composer will save it for future use:

composer config --global --auth github-oauth.github.com [your_token_here]

Read more on this in the Composer Docs.

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.

statamic-cli's People

Contributors

jesseleite avatar jasonvarga avatar jackmcdade avatar robdekort avatar benfurfie avatar jonassiewertsen avatar alwaysblank avatar joshuablum avatar duncanmcclean avatar lbennett-stacki avatar rossalexander avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.