# site-cli

**Repository Path**: mirrors/site-cli

## Basic Information

- **Project Name**: site-cli
- **Description**: Site CLI 是一个使用 PHP 开发的命令行工具，可以帮助更容易的使用 Nginx
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2017-07-23
- **Last Updated**: 2026-02-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Site CLI
========
[![Build Status](https://travis-ci.org/panlatent/site-cli.svg)](https://travis-ci.org/panlatent/site-cli)
[![Latest Stable Version](https://poser.pugx.org/panlatent/site-cli/v/stable.svg)](https://packagist.org/packages/panlatent/site-cli) 
[![Total Downloads](https://poser.pugx.org/panlatent/site-cli/downloads.svg)](https://packagist.org/packages/panlatent/site-cli) 
[![Latest Unstable Version](https://poser.pugx.org/panlatent/site-cli/v/unstable.svg)](https://packagist.org/packages/panlatent/site-cli) 
[![License](https://poser.pugx.org/panlatent/site-cli/license.svg)](https://packagist.org/packages/panlatent/site-cli)

A command-line tool that help you more easily use Nginx.

What's This
------------
Site CLI is a command-line tool that helps you manage and switch Nginx local development 
environment configuration files.

This tool makes me lazy in the development, It's more than just `cd && ls`, `ln -s`, `nginx -s` , I enjoy it.

Features
---------
+ **Auto-Completion** - Supports all commands, arguments and options auto-completion.
+ **Grouping** - Uses directories to group site configuration files. Support the operation of any item and ane group.
+ **List** - Use `ls` command quick see site list and information.
+ **Switch** - Use `enable/disable` command can quick switching site or group, it support service auto reload.
+ **Service** - Help you use the same command control service in different environments.
+ **Alfred3 Workflow Support** -  Provide workflow helpe you quick search and switch site.

Installation
-------------
Download Phar file: 
+ [Phar Releases]((https://github.com/panlatent/site-cli/releases))

```bash
$ mv site-cli.phar /usr/local/bin/site
$ chmod +x /usr/local/bin/site
```

Download the library using composer:

```bash
$ composer require panlatent/site-cli
```

```bash
$ ln -s ./bin/site-cli /usr/local/bin/site
$ chmod +x /usr/local/bin/site
```

Configuration
-------------
### Custom Configuration

The default configuration provided by Site Cli works very well, but you can still customize it.

Run `init` command will create a .site-cli.yml file to your home directory.
Edit this file:

```yaml
site:
  available: ~/etc/nginx/sites-available
  enabled: ~/etc/nginx/sites-enabled
```

### Add Completion

Run `init --dump-completion` will make a completion script contents and print to the terminal.
Use `-o, --output[=OUTPUT]` will write to a file. 
Add shell complete in `~/.zshrc` or `~/.bash_profile`: `source ~/.site-cli.sh`

A example: 

```bash
$ site init --dump-completion -o ~/.site-cli.bash
$ echo "source .site-cli.bash" >> ~/.zshrc
```

Usage
-----

```bash
$ site [command] [argment]
```

Command List:

+ **clear**    - Clear unless symbolic links
+ **config**   - Get and set site-cli options
+ **create**   - Create a new site
+ **disable**  - Disable a site or a group sites
+ **edit**     - Edit site configuration using editor
+ **enable**   - Enable a site or a group sites
+ **help**     - Displays help for a command
+ **init**     - Init site-cli settings
+ **ls**       - List groups and sites contents
+ **service**  - Control site service process

Optional
---------

### Add nginx.conf vim syntax:
Download nginx.vim [nginx vim](http://www.vim.org/scripts/script.php?script_id=1886)

```bash
$ mv nginx.vim ~/.vim/syntax/
$ vi ~/.vim/filetype.vim
```
Add `au BufRead,BufNewFile your_nginx_path/* set ft=nginx`

License
-------
The Site CLI is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).