Document public releases and standalone CLI version compatibility
This commit is contained in:
1 parent
e4fb4f309f
commit
e3f1be2f6f
2 files changed
+7
-8
No files matched your search
+1
-1
@@ -14,7 +14,7 @@ rpm/debは初期配布の必須条件にせず、LinuxはELFを提供する。Py
|
||||
|
||||
## インストール
|
||||
|
||||
Releases画面からOSに合うtar.gzと `*-SHA256SUMS` をダウンロードする。非公開リポジトリではGiteaへのログインが必要。資格情報をコマンドライン引数や公開URLに埋め込まない。
|
||||
[公開Releases](https://git.anya.jp/anya/pages-cli/releases)からOSに合うtar.gzと `*-SHA256SUMS` をダウンロードする。ダウンロードにログインは不要。PagesWikiへの接続に使う資格情報をコマンドライン引数や公開URLに埋め込まない。
|
||||
|
||||
```sh
|
||||
# ダウンロード先で実行。手元にあるファイルをチェックする。
|
||||
|
||||
@@ -38,7 +38,7 @@ pages[default]:/manual> exit
|
||||
|
||||
### OIDCでログインする
|
||||
|
||||
OIDC連携を有効にしたDomainで利用します。サーバーとCLIの両方に **v0.3.0以降** が必要です。
|
||||
OIDC連携を有効にしたDomainで利用します。サーバーは **v0.3.0以降** が必要です。独立版CLI v0.1.0は対応済みです(分離前のCLIではサーバー同梱版v0.3.0以降)。
|
||||
CLIのファイルだけを更新しても、v0.2.xのサーバーでは利用できません。
|
||||
|
||||
```sh
|
||||
@@ -130,7 +130,7 @@ Tab補完、上下キーのプロセス内履歴に対応。複雑な引用位
|
||||
|
||||
### 言語を指定して編集する
|
||||
|
||||
`auto` 言語選択と未作成言語版の編集は、v0.4.0以降のCLIで利用できます。
|
||||
`auto` 言語選択と未作成言語版の編集は、独立版CLI v0.1.0で利用できます(分離前はサーバー同梱版v0.4.0以降)。
|
||||
|
||||
```sh
|
||||
pages edit /guide --lang auto # 表示される言語の最新版を編集
|
||||
@@ -145,18 +145,17 @@ pages edit /guide --lang en # 英語版。未作成なら既存内容から
|
||||
|
||||
対応範囲は既存Pageの更新と新規言語版の作成です。新規Path/Page作成、バイナリ更新は未実装です。
|
||||
競合や通信断で自動上書きせず、ローカル原稿を保持します。HTTPS必須(開発用loopbackのみHTTP可)。
|
||||
詳しいURI・保存・安全性の契約は[設計書](../docs/design/ja/remote-cli.md)を参照してください。
|
||||
詳しいURI・保存・安全性の契約はサーバーリポジトリの `docs/design/ja/remote-cli.md` にあります(同リポジトリへのアクセス権が必要です)。
|
||||
|
||||
## テスト
|
||||
|
||||
```sh
|
||||
python3 pages-cli/test_pages.py
|
||||
go test ./internal/server -run TestRemoteCLIHTTPIntegration -count=1
|
||||
python3 -m unittest test_pages test_productivity test_distribution
|
||||
```
|
||||
|
||||
偽サーバと一時DBのみを使用します。本番資格情報や外部カレンダーは不要です。
|
||||
合成サーバーと一時ディレクトリのみを使用します。本番資格情報や外部カレンダーは不要です。Goサーバーとの結合テストはサーバーリポジトリ側で実行します。
|
||||
## タスクと連絡先
|
||||
|
||||
`pages task --help` で作成・計画・開始/終了・レポートを操作できる。
|
||||
`pages contacts --help` で個人アドレス帳の検索・vCard入出力を行える。
|
||||
[neomutt設定と操作例](../docs/operations/neomutt-tasks.md)を参照。
|
||||
neomutt設定と操作例はサーバーリポジトリの `docs/operations/neomutt-tasks.md` を参照。
|
||||
Reference in new issue
Block a user