はじめ
先日のリリースノートにて発表されたこちらの Qiita CLI 興味があったのでこちらを使って記事を投稿してみようと思います。
準備
基本的に以下のREADMEを参考に準備を進めます(ドキュメントが日本語なのでわかりやすいです!)
1. Node.js(18.0.0以上)が必要とのことでリポジトリを作ってそこにnodenvでバージョン指定する
$ mkdir qiita-project
$ nodenv install 19.2.0
$ nodenv local 19.2.0
2. Qiita CLIをインストールとセットアップ
npm からQiita CLIパッケージをインストールし、セットアップコマンドを実行して初期準備を行う
$ npm install @qiita/qiita-cli --save-dev
$ npx qiita init
3. Qiitaからアクセストークンを作成、CLI上で認証設定
GUI上でアクセストークンを作成(read_qiita
write_qiita
にチェック)してそれを一時メモ
CLI上でメモしたアクセストークンを使用して認証
$ npx qiita login
Enter your token: [アクセストークン]
Hi Satoooon!
私は git 管理したかったのでこちらで first commitを行いました
記事の作成
1. ベースファイルの生成
記事は public/ に格納しなければいけないようなのでディレクトリの作成と作成用のコマンドがあるのでそちらを使ってマークダウンファイルの生成を行います
$ mkdir public
$ npx qiita new article1
2. 記事の設定、本文の執筆
上記生成コマンドを実施すると public配下にマークダウンファイルが作成されています。そちらを開き諸々設定を行います(設定の諸々についてはREADMEを参照してみてください)
とりあえず私は以下の感じで設定をしてみます(マークダウン記法を知っている方でしたら問題なく使用できそうです)
---
title: こちらQiita CLIで記事を書いたものです
tags:
- Qiita
private: false
updated_at: ''
id: null
organization_url_name: ruby-dev
---
# new article body
3. プレビューモード
執筆途中のものはプレビューモードで閲覧可能とのことで一回実行してみました
するとQiitaとの同期が行われ公開済みの記事がマークダウン形式でpullされてきました(ファイル名はidになっていました)
$ npx qiita preview
Preview: http://localhost:8888
こちらでネット環境がなくても手元の環境でプレビュー表示ができます!
4. 公開
記事が執筆できたので公開コマンドにより公開をします
$ npx qiita publish article1
※ 後にこの記事のURLをCLI内で執筆した記事に添付したく更新も行いましたが、公開も上記と同じコマンドでできます
こちらQiita CLIから試しに投稿した記事になります
所感
- ネット環境がなくても執筆が進められることができることとプレビュー画面を手元の環境で立ち上げて確認できるのは良かったです
- 今回は手元のコンソールから投稿だけ行いましたが、Github のワークフローなどを活用して連携することもできるようなので便利に使えるCLIですね
- 現状、CLIは公開・更新のみで削除等のコマンドはありませんが、CLIで削除は誤って削除してしまうと怖いと思うので一旦無くても良いかなと思います(削除機能があればそれはそれで便利だと思いますが)
- 逆にネット環境がなくても記事が書けることができますが、画像の添付はあらかじめURLの指定が必要なためネット環境がなければ手元の画像をすぐに添付できないのは少し勿体無いなと感じました
- 今後の改修で公開時に手元に格納している画像をアップロードと特定のフォーマットで指定していた箇所に添付を行えるような機能があると便利そうだなと思います
- まだベータ版とのことで今後こちらの機能に期待したいです!