PHPackages                             getkirby/cli - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [CLI & Console](/categories/cli)
4. /
5. getkirby/cli

ActiveLibrary[CLI & Console](/categories/cli)

getkirby/cli
============

Kirby command line interface

1.9.0(6mo ago)6581.6k↓49.7%7[8 issues](https://github.com/getkirby/cli/issues)[3 PRs](https://github.com/getkirby/cli/pulls)20MITPHPPHP ~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0 || ~8.5.0CI passing

Since Oct 2Pushed 4d ago5 watchersCompare

[ Source](https://github.com/getkirby/cli)[ Packagist](https://packagist.org/packages/getkirby/cli)[ Docs](https://getkirby.com)[ Fund](https://getkirby.com/buy)[ RSS](/packages/getkirby-cli/feed)WikiDiscussions main Synced 2d ago

READMEChangelog (10)Dependencies (3)Versions (17)Used By (20)

Kirby CLI
=========

[](#kirby-cli)

The Kirby command line interface helps simplifying common tasks with your Kirby installations.

Installation
------------

[](#installation)

### Via Composer

[](#via-composer)

```
composer global require getkirby/cli

```

Make sure to add your composer bin directory to your `~/.bash_profile` (Mac OS users) or into your `~/.bashrc` (Linux users).

Your global composer directory is normally either `~/.composer/vendor/bin` or `~/.config/composer/vendor/bin`. You can find the correct path by running …

```
composer -n config --global home

```

Afterwards, add the result to your bash profile …

```
export PATH=~/.composer/vendor/bin:$PATH

```

### Did it work?

[](#did-it-work)

Check if the installation worked by running the following in your terminal.

```
kirby

```

This should print the Kirby CLI version and a list of available commands

Available core commands
-----------------------

[](#available-core-commands)

```
- kirby backup
- kirby clean:content
- kirby clear:cache
- kirby clear:lock
- kirby clear:logins
- kirby clear:media
- kirby clear:sessions
- kirby download
- kirby help
- kirby install
- kirby install:kit
- kirby install:repo
- kirby license:info
- kirby license:renewal
- kirby make:blueprint
- kirby make:collection
- kirby make:command
- kirby make:config
- kirby make:controller
- kirby make:language
- kirby make:model
- kirby make:plugin
- kirby make:snippet
- kirby make:template
- kirby make:user
- kirby migrate:to:public-folder
- kirby migrate:to:root-folder
- kirby plugin:install
- kirby plugin:remove
- kirby plugin:upgrade
- kirby register
- kirby remove:command
- kirby roots
- kirby security
- kirby unzip
- kirby upgrade
- kirby uuid:duplicates
- kirby uuid:generate
- kirby uuid:populate
- kirby uuid:remove
- kirby version

```

Writing commands
----------------

[](#writing-commands)

You can create a new command via the CLI:

```
kirby make:command hello
```

This will create a new `site/commands` folder in your installation with a new `hello.php` file

The CLI will already put the basic scaffolding into the file:

```