PHPackages                             shlinkio/shlink-installer - 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. shlinkio/shlink-installer

ActiveLibrary

shlinkio/shlink-installer
=========================

A PHP command line tool used to install shlink

v10.0.0(3mo ago)763.9k↓20.3%3[5 issues](https://github.com/shlinkio/shlink-installer/issues)1MITPHPPHP ^8.4CI passing

Since Feb 6Pushed 3mo ago1 watchersCompare

[ Source](https://github.com/shlinkio/shlink-installer)[ Packagist](https://packagist.org/packages/shlinkio/shlink-installer)[ Docs](https://shlink.io)[ RSS](/packages/shlinkio-shlink-installer/feed)WikiDiscussions develop Synced 1mo ago

READMEChangelog (10)Dependencies (15)Versions (55)Used By (1)

Shlink installer
================

[](#shlink-installer)

A PHP command line tool used to install [shlink](https://shlink.io/).

[![Build Status](https://camo.githubusercontent.com/5dd9be493edf9ed4240da570493f6e89ab226f10893cd271dd5b3153e95f5ebe/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f616374696f6e732f776f726b666c6f772f7374617475732f73686c696e6b696f2f73686c696e6b2d696e7374616c6c65722f63692e796d6c3f6272616e63683d646576656c6f70266c6f676f3d676974687562267374796c653d666c61742d737175617265)](https://github.com/shlinkio/shlink-installer/actions/workflows/ci.yml?query=workflow%3A%22Continuous+integration%22)[![Code Coverage](https://camo.githubusercontent.com/f34ec9c4f1dacdd344d600d20edab188eada6da0f2a2b4fa5be236dd0fcc2895/68747470733a2f2f696d672e736869656c64732e696f2f636f6465636f762f632f67682f73686c696e6b696f2f73686c696e6b2d696e7374616c6c65722f646576656c6f703f7374796c653d666c61742d737175617265)](https://app.codecov.io/gh/shlinkio/shlink-installer)[![Latest Stable Version](https://camo.githubusercontent.com/9c7e3aebfe4097a5e99e5343d07934182d28ecef5247bc73bc47de0396d12689/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f73686c696e6b696f2f73686c696e6b2d696e7374616c6c65722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/shlinkio/shlink-installer)[![License](https://camo.githubusercontent.com/141c19bcd22f1f0eb480a75a12cd093188e30b083eecef09e86a05fa640fd1c4/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f73686c696e6b696f2f73686c696e6b2d696e7374616c6c65722e7376673f7374796c653d666c61742d737175617265)](https://github.com/shlinkio/shlink-installer/blob/main/LICENSE)[![Paypal donate](https://camo.githubusercontent.com/f7bd7ab1d7bea7a4ac78f5189c56ce2dbf8cc73608863e0dd9408e10ddca4673/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f446f6e6174652d70617970616c2d626c75652e7376673f7374796c653d666c61742d737175617265266c6f676f3d70617970616c26636f6c6f72413d616161616161)](https://slnk.to/donate)

[![Shlink installer](shlink-installer.gif)](shlink-installer.gif)

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

[](#installation)

Install this tool using [composer](https://getcomposer.org/).

```
composer install shlinkio/shlink-installer

```

Usage
-----

[](#usage)

This is the command line tool used by [shlink](https://github.com/shlinkio/shlink) to guide you through the installation process.

The tool expects the working directory to be a valid shlink instance.

In order to run it, use the built-in CLI entry point.

Run `vendor/bin/shlink-installer` to print all available commands.

```
Shlink installer

Usage:
  command [options] [arguments]

Options:
  -h, --help            Display help for the given command. When no command is given display help for the list command
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi|--no-ansi  Force (or disable --no-ansi) ANSI output
  -n, --no-interaction  Do not ask any interactive question
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Available commands:
  help        Display help for a command
  install     Guides you through the installation process, to get Shlink up and running.
  list        List commands
  set-option  Allows you to set new values for any config option.
  update      Helps you import Shlink's config from an older version to a new one.

```

The most important ones are these:

- `install`: Used to set up Shlink from scratch.
- `update`: Used to update an existing Shlink instance. Will allow importing the config, skipping the options that already have a value.
- `set-option`: Allows to set the value for an individual option, in case you want to update it.

Customize options
-----------------

[](#customize-options)

### Questions to ask the user

[](#questions-to-ask-the-user)

In order to retain backwards compatibility, it is possible to configure the installer to ask just a specific subset of questions.

Add a configuration file including a configuration like this:

```