xserver-cli 0.9.5 → 1.0.0-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,17 +1,54 @@
1
- # xserver-cli
2
- NodeJS无服务框架XServer快速开发CLI工具
3
-
4
- [传送门:XServer官网文档](http://www.xserver.top)
5
-
6
- 使用说明
7
- >
8
- npm install xserver-cli -g
9
-
10
- xcli x-koa myproject
11
-
12
-
13
- 帮助联系
14
- >
15
- 作者:cheneyxu
16
- 邮箱:457299596@qq.com
17
- QQ:457299596
1
+ # xserver-cli
2
+
3
+ XServer の公式 CLI ツール。ターミナルから XServer のレンタルサーバーを管理できます。
4
+
5
+ ## インストール
6
+
7
+ ```bash
8
+ npm install -g xserver-cli
9
+ ```
10
+
11
+ ## 使い方
12
+
13
+ ### 認証
14
+
15
+ ```bash
16
+ xserver auth login
17
+ # APIキーを入力
18
+ ```
19
+
20
+ APIキーは [XServer サーバーパネル](https://secure.xserver.ne.jp/) > APIキー管理 から取得できます。
21
+
22
+ ### コマンド例
23
+
24
+ ```bash
25
+ # サーバー情報取得
26
+ xserver server info
27
+
28
+ # WordPress一覧
29
+ xserver server wp list
30
+
31
+ # ドメイン追加
32
+ xserver server domain add example.com
33
+
34
+ # 詳細はヘルプを参照
35
+ xserver --help
36
+ xserver server --help
37
+ ```
38
+
39
+ ### 環境変数(CIなどで使用)
40
+
41
+ ```bash
42
+ export XSERVER_API_KEY=your_api_key
43
+ export XSERVER_SERVERNAME=xs123456.xsrv.jp
44
+ xserver server info
45
+ ```
46
+
47
+ ## ドキュメント
48
+
49
+ - [XServer Developer Portal](https://developer.xserver.ne.jp)
50
+ - [GitHub リポジトリ](https://github.com/xserver-inc/xserver-npm-packages)
51
+
52
+ ## ライセンス
53
+
54
+ MIT