intreface.cli
Version:
Intreface Dev Tools
256 lines (195 loc) • 4.97 kB
Markdown
intreface.cli
=============
Intreface Dev Tools for Bitrix24, Bitrix development on Windows.
[](https://oclif.io)
[](https://npmjs.org/package/intreface.cli)
[](https://npmjs.org/package/intreface.cli)
[](https://github.com/mikkiek/intreface.cli/blob/master/package.json)
<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
* [Notes](#notes)
<!-- tocstop -->
* [Usage](#usage)
* [Commands](#commands)
* [Notes](#notes)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g intreface.cli
$ intreface COMMAND
running command...
$ intreface (-v|--version|version)
intreface.cli/1.0.21 win32-x64 node-v14.15.1
$ intreface --help [COMMAND]
USAGE
$ intreface COMMAND
...
```
<!-- usagestop -->
```sh-session
$ npm install -g intreface.cli
$ intreface COMMAND
running command...
$ intreface (-v|--version|version)
intreface.cli/1.0.20 win32-x64 node-v14.15.1
$ intreface --help [COMMAND]
USAGE
$ intreface COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`intreface bitrix [ACTION]`](#intreface-bitrix-action)
* [`intreface help [COMMAND]`](#intreface-help-command)
* [`intreface info [INFO]`](#intreface-info-info)
* [`intreface init`](#intreface-init)
* [`intreface project [ACTION]`](#intreface-project-action)
* [`intreface test`](#intreface-test)
## `intreface bitrix [ACTION]`
```
Bitrix helper
USAGE
$ intreface bitrix [ACTION]
OPTIONS
--config=config
EXAMPLES
$ intreface bitrix create
$ intreface bitrix create --config=no-update
$ intreface bitrix create --config=restore
$ intreface bitrix remove
$ intreface bitrix list
$ intreface bitrix link
$ intreface bitrix renew
$ intreface bitrix license
$ intreface bitrix update
$ intreface bitrix lock
$ intreface bitrix unlock
```
## `intreface help [COMMAND]`
```
display help for <%= config.bin %>
USAGE
$ intreface help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.3/src/commands/help.ts)_
## `intreface info [INFO]`
```
Display info
USAGE
$ intreface info [INFO]
EXAMPLE
$ intreface info config
```
## `intreface init`
```
Initialize intreface.cli Config
USAGE
$ intreface init
OPTIONS
--config=config
EXAMPLES
$ intreface init
$ intreface init --config=mysql-login
```
## `intreface project [ACTION]`
```
Project helper
USAGE
$ intreface project [ACTION]
EXAMPLES
$ intreface project gitignore
$ intreface project watch
$ intreface project sync
```
## `intreface test`
```
Test code
USAGE
$ intreface test
```
<!-- commandsstop -->
* [`intreface bitrix [ACTION]`](#intreface-bitrix-action)
* [`intreface help [COMMAND]`](#intreface-help-command)
* [`intreface info [INFO]`](#intreface-info-info)
* [`intreface init`](#intreface-init)
* [`intreface project [ACTION]`](#intreface-project-action)
* [`intreface test`](#intreface-test)
## `intreface bitrix [ACTION]`
```
Bitrix helper
USAGE
$ intreface bitrix [ACTION]
OPTIONS
--config=config
EXAMPLES
$ intreface bitrix create
$ intreface bitrix create --config=no-update
$ intreface bitrix create --config=restore
$ intreface bitrix remove
$ intreface bitrix list
$ intreface bitrix link
$ intreface bitrix renew
$ intreface bitrix license
$ intreface bitrix update
$ intreface bitrix lock
$ intreface bitrix unlock
```
## `intreface help [COMMAND]`
```
display help for <%= config.bin %>
USAGE
$ intreface help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.3/src/commands/help.ts)_
## `intreface info [INFO]`
```
Display info
USAGE
$ intreface info [INFO]
EXAMPLE
$ intreface info config
```
## `intreface init`
```
Initialize intreface.cli Config
USAGE
$ intreface init
OPTIONS
--config=config
EXAMPLES
$ intreface init
$ intreface init --config=mysql-login
```
## `intreface project [ACTION]`
```
Project helper
USAGE
$ intreface project [ACTION]
EXAMPLES
$ intreface project gitignore
$ intreface project watch
$ intreface project sync
```
## `intreface test`
```
Test code
USAGE
$ intreface test
```
<!-- commandsstop -->
# Notes
<!-- notes -->
* [WinNMP](https://winnmp.wtriple.com/) required or similar windows environment with nginx and php-fpm(php-cgi)
* Nginx configs should be inside WinNMP directory ./conf/nginx/sites/
* Bitrix create functionality is not available for external users by internal rules