# yii-base-cli

**Repository Path**: mirrors_yiisoft/yii-base-cli

## Basic Information

- **Project Name**: yii-base-cli
- **Description**: Yii Framework Command Line Application
- **Primary Language**: Unknown
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-19
- **Last Updated**: 2026-02-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
    <a href="http://www.yiiframework.com/" target="_blank">
        <img src="https://www.yiiframework.com/files/logo/yii.png" width="400" alt="Yii Framework" />
    </a>
    <h1 align="center">Yii Framework Command Line Application</h1>
    <br>
</p>

This package is [Yii Framework] Command Line application best for rapidly creating projects.

The template includes all commonly used configurations that would allow you to focus on adding new
features to your application.

[Yii Framework]: http://www.yiiframework.com/

[![Latest Stable Version](https://img.shields.io/packagist/v/yiisoft/yii-base-cli.svg)](https://packagist.org/packages/yiisoft/yii-base-cli)
[![Total Downloads](https://img.shields.io/packagist/dt/yiisoft/yii-base-cli.svg)](https://packagist.org/packages/yiisoft/yii-base-cli)
[![Build Status](https://travis-ci.com/yiisoft/yii-base-cli.svg?branch=master)](https://travis-ci.com/yiisoft/yii-base-cli)

DIRECTORY STRUCTURE
-------------------

```
config/             contains application configurations
runtime/            contains files generated during runtime
src/
  commands/           contains console commands (controllers)
tests/              contains various tests for the basic application
vendor/             contains dependent 3rd-party packages
.env
.env.dist
composer.json
```

REQUIREMENTS
------------
 

The minimum requirement by this project template that your Web server supports PHP 7.2.


INSTALLATION
------------

If you do not have [Composer](http://getcomposer.org/), you may install it by following the instructions
at [getcomposer.org](http://getcomposer.org/doc/00-intro.md#installation-nix).

You can then install this project template using the following command:

~~~
composer create-project --prefer-dist --stability=dev yiisoft/yii-base-cli myapp
cd myapp
./vendor/bin/yii serve
~~~

Now you should be able to access the application via `http://localhost:8080/`.

CONFIGURATION
-------------

### Database

Edit the file `config/db.php` with real data, for example:

```php
return [
    '__class' => \Yiisoft\Db\Connection::class,
    'dsn' => 'mysql:host=localhost;dbname=yii2basic;charset=utf8',
    'username' => 'root',
    'password' => '1234',
];
```

**NOTES:**
- Yii won't create the database for you, this has to be done manually before you can access it.
- Check and edit the other files in the `config/` directory to customize your application as required.
- Refer to the README in the `tests` directory for information specific to basic application tests.


TESTING
-------

Tests are located in `tests` directory.