Skip to content

Commit

Permalink
Documentation updated
Browse files Browse the repository at this point in the history
  • Loading branch information
miamibc committed Nov 15, 2020
1 parent 63b6f76 commit 67187d3
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
<img title="Cloudflare" alt="Cloudflare" height="100" src="https://www.cloudflare.com/img/logo-cloudflare-dark.svg"/> cli
</h1>

Command-line client of [Cloudflare API](https://api.cloudflare.com/) written in PHP.
Command-line client of [Cloudflare API](https://api.cloudflare.com/) written in PHP. Allows to:
- Execute Cloudflare API commands, like listing available `zones` or changing `zones:settings:development_mode`
- Parse documentation
- Generate commands from parsed information (Not completed yet)

## Start cloudflare-cli

Expand Down Expand Up @@ -68,8 +71,6 @@ To get more information on command, add `help` and `command` you need to get hel
cloudflare-cli help zones:settings:development_mode
```



## Extend cloudflare-cli

Project is made with help of [Laravel Zero](https://laravel-zero.com/) framework.
Expand Down Expand Up @@ -103,12 +104,18 @@ php cloudflare-cli make:command

And add functionality to the new file in `app/Commands` directory.

You can add `App\Cloudflare\Client $client` as a parameter of `handle()` method, to inject very simple and useful Cloudflare client, that performs authorization and has possibility to parse documentation.
You can add `App\Cloudflare\Client $client` as a parameter of `handle()` method, to inject very simple and useful Cloudflare client, that performs authorization, results pagination and possibility to parse documentation.

### Test

To test components, run phpunit
```
php vendor/bin/phpunit
```

### Create binary

To create phar file, use this command and answer few questions

```
php cloudflare-cli app:build
```
Expand Down

0 comments on commit 67187d3

Please sign in to comment.