Dev Center CLI

最終更新日 2022年01月25日(火)

インストール
記事を取り出す
ローカルで編集およびプレビューする
プレビューを停止する
記事を Dev Center に保存する
追加のヘルプ
問題とプルリクエスト

Dev Center CLI では、作成者が Dev Center の記事をローカルで編集やプレビューできます。

インストール

ローカルマシンで Ruby をセットアップします。その後、Dev Center CLI gem をインストールします。

$ gem install devcenter

記事を Dev Center に保存したい場合は、Heroku CLI も必要になります。

記事を取り出す

devcenter pull の後に記事 URL を続けて、記事のローカルコピーをダウンロードします。

$ devcenter pull https://devcenter.heroku.com/articles/dev-center-cli
"Dev Center CLI" article saved as ~/.../dev-center-cli.md

これにより dev-center-cli.md テキストファイルがローカルディレクトリに保存されます。

ローカルで編集およびプレビューする

このファイルをテキストエディタで開きます。ファイルの中にいくつかのメタデータがあり、その後に記事内容が Markdown 形式で続いています。

次のコマンドを実行すると、プレビューがデフォルトのブラウザで開きます。

$ devcenter preview dev-center-cli
Live preview for error-pages available in  http://127.0.0.1:3000/dev-center-cli
It will refresh when you save ~/.../dev-center-cli.md
Press Ctrl+C to exit...

ここで、記事の内容の編集を開始します。プレビューはファイルを保存すると自動更新されるため、編集している内容とそのプレビューが並んで表示されます。

メタデータ

Markdown ファイルには、いくつかのメタデータフィールドがあります。title を編集することはできますが、id フィールドは上書きしないでください。このフィールドは、変更を Dev Center に保存するために必要になります。

プレビューを停止する

preview コマンドを停止するには、Ctrl+C を押します。

記事を Dev Center に保存する

devcenter push コマンドを使用してローカルの変更を Dev Center に保存します。

$ devcenter push dev-center-cli.md

ローカルの heroku アカウントが記事をプッシュするために使用されます。別のアカウントでログインする場合は、heroku auth:whoami を使用してどのアカウントが記事と heroku auth:login をプッシュするために使用されるかを確認します。

追加のヘルプ

使用可能なすべてのコマンドのリストを、次のコマンドで取得します。

$ devcenter help

特定のコマンドのヘルプと使用可能なオプション (previewなど) を取得します。

$ devcenter help preview

問題とプルリクエスト

Dev Center CLI はオープンソースです。そのリポジトリにアクセスしてコードを取得したり、問題を報告したり、プルリクエストを送信したりできます。

Categories