Zenn
📝

K-V型でメモできるCLIツールを開発した話

2023/05/04に公開
Rust
CLI
tech

今回開発したCLIツール（kvmm）について

kvmmとは、私が開発したK-V型でメモできるCLIツールです。

このツールを開発しようと思ったきっかけとしては仕事中に簡単なメモを残す際にいちいちGUIのメモアプリを起動したりファイルにメモをしたりと少しめんどくさいと感じていたためです。

このツールのメリットは以下です

  • コマンド上でメモできる
  • コマンド上からメモを呼び出せるためアプリやファイルを開く必要がない

インストール方法

まずはバイナリをダウンロードします。

wget https://github.com/ushinohama966/kvmm/releases/download/[version]/kvmm.tar.gz
tar -zxvf kvmm.tar.gz
rm kvmm.tar.gz

次に環境変数としてmemo.jsonファイルのパスをしていすれば完了です

export MEMO_FILE_PATH=[path/to/memo.json]

使い方

基本的な機能はメモの追加(add)、出力(get)、削除(delete)です。

add

❯ kvmm add -k key -v value
add >>> {"key":"value"}

get

❯ kvmm get -k key
value

delete

❯ kvmm delete -k key
delete >>> {"key":"value"}

他にも機能があります

❯ kvmm -h
Usage: kvmm <COMMAND>

Commands:
  add     
  update  
  delete  
  list    
  get     
  clean   
  help    Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

今気づきましたけどコマンドの説明がありませんね。
これもまた対応しておきます。

開発技術の選定理由

使用技術はRustです。なぜRustで開発したのかというとほぼほぼ私の勉強目的ですw

まあ開発するのがそれほど難しくなかったので別にRustを使うこともなかったですが、、、

あとはclapというCLIツールを開発するのに便利なクレートがあったくらいですかね

感想

はじめてCLIツールを開発しましたがクレートの力もあってかあっさり作れてしまい少し物足りない感じはしますが、いつも使用しているCLIツールを開発側からの視点でみれておもしろかったです。

やはりいろいろな領域を開発してみるというのは良い経験になりますね。

何か改善点があれば是非教えてください！

最後にこのツールはこれからも開発していく予定なので貢献してくれる方はこちらからお願いします！

Discussion