{"id":14963443,"url":"https://github.com/miso-develop/opniz-cli","last_synced_at":"2026-02-11T17:03:23.287Z","repository":{"id":57298323,"uuid":"443296077","full_name":"miso-develop/opniz-cli","owner":"miso-develop","description":"opniz CLIはopniz Arduino LibraryのBasicスケッチを、コマンドから簡単に書き込めるCLIツールです。","archived":false,"fork":false,"pushed_at":"2024-06-17T18:22:34.000Z","size":1431,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-16T16:47:31.357Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/miso-develop.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-12-31T08:27:04.000Z","updated_at":"2022-12-11T03:19:56.000Z","dependencies_parsed_at":"2024-09-13T19:15:47.453Z","dependency_job_id":"e8f15712-9733-4d98-bd00-06d832db35f2","html_url":"https://github.com/miso-develop/opniz-cli","commit_stats":{"total_commits":88,"total_committers":3,"mean_commits":"29.333333333333332","dds":0.03409090909090906,"last_synced_commit":"c4adac820bb8be44c68775f62921405a9a0fadd9"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miso-develop%2Fopniz-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miso-develop%2Fopniz-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miso-develop%2Fopniz-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/miso-develop%2Fopniz-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/miso-develop","download_url":"https://codeload.github.com/miso-develop/opniz-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247393572,"owners_count":20931813,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-24T13:31:30.731Z","updated_at":"2026-02-11T17:03:18.268Z","avatar_url":"https://github.com/miso-develop.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# opniz CLI\n\nopniz CLIは[opniz Arduino Library](https://github.com/miso-develop/opniz-arduino-m5unified)の[Basicスケッチ](https://github.com/miso-develop/opniz-arduino-m5atom/blob/main/examples/Basic/Basic.ino)を、コマンドから簡単に書き込めるCLIツールです。  \n[Arduino CLI](https://github.com/arduino/arduino-cli)のラッパーCLIです。  \n\n\u003cimg src=\"https://user-images.githubusercontent.com/22117028/148371155-569e2ae3-7655-4c5c-a38f-4d13dd1ada4b.gif\" width=\"640\"\u003e\n\n\n\n## 対応デバイス\n\n* M5Stack BASIC\n* M5Stack Core2\n* M5StickC\n* M5ATOM Matrix\n* M5ATOM Lite\n* M5ATOM Echo\n* M5ATOM U\n* M5ATOMS3\n* M5ATOMS3 Lite\n* M5Stamp Pico\n* M5Stamp S3\n* その他ESP32、ESP32-PICO-D4、ESP32-S3デバイス\n\n\n\n## インストール\n\n```sh\n$ npm install -g opniz-cli\n```\n\nインストール時に`~/.opniz-cli/`へ[Arduino CLI](https://github.com/arduino/arduino-cli)の環境をセットアップします。  \nそのためインストールに数分かかり、約800MBほどストレージを消費します。  \n\n\n\n## 使い方\n\n```sh\n$ opniz -h\nUsage: index [options] [command]\n\nOptions:\n  -v, --version                   バージョンを表示します。\n  -h, --help                      コマンドのヘルプを表示します。\n\nCommands:\n  upload [options] [device-port]  デバイスへopnizを書き込みます。\n  monitor [device-port]           シリアルモニタを表示します。\n  list                            接続されているデバイス情報を表示します。\n  arduino [\"options\"]             Arduino CLIを直接実行します。[options]をダブルクォーテーションで括って実行してください。（例：opniz arduino \"version\"）\n  help [command]                  display help for command\n```\n\n### `upload`: opnizスケッチ書き込み\n\nデバイスへopnizスケッチを書き込みます。  \n\nデバイスのシリアルポートやWi-Fi情報、opnizプログラムを実行するマシンのIPアドレスといった情報を対話モードで入力していきます。  \nシリアルポート、Wi-FiのSSID、IPアドレスの候補は動的にリスト生成されるので簡単に選択できます。  \n\n```sh\nopniz upload\n```\n\n\u003cimg src=\"https://user-images.githubusercontent.com/22117028/148371155-569e2ae3-7655-4c5c-a38f-4d13dd1ada4b.gif\" width=\"640\"\u003e\n\nリストにない値を指定したい場合は`Other`を選択することで直接入力できます。  \n\nまた以下のようにオプション指定することで対話モードをスキップして実行できます。  \n部分的なオプション指定も可能です。  \n\n```sh\nopniz upload \u003cdevice-port\u003e -s \u003cssid\u003e -p \u003cpassword\u003e -a \u003caddress\u003e -d \u003cdevice\u003e -P 3000\n```\n\n|オプション|必須|内容|\n|---|:-:|---|\n|`\u003cdevice-port\u003e`|✔|デバイスのシリアルポートを指定します。|\n|`-s, --ssid \u003cssid\u003e`|✔|デバイスを接続するWi-FiのSSIDを指定します。|\n|`-p, --password \u003cpassword\u003e`|✔|デバイスを接続するWi-Fiのパスワードを指定します。|\n|`-a, --address \u003caddress\u003e`|✔|opnizプログラム実行マシンのIPアドレスまたはホスト名、ドメイン名を指定します。|\n|`-d, --device \u003cdevice\u003e`|✔|デバイスを指定します。\u003cbr\u003e`m5atom`、`m5stickc`、`m5stack`、`esp32`のいずれかを指定します。|\n|`-P, --port \u003cport\u003e`|✔|opnizプログラムの通信ポート番号を指定します。|\n|`-i, --id \u003cid\u003e`||opniz IDを指定します。|\n|`-h, --help`||コマンドのヘルプを表示します。|\n\n### `monitor`: シリアルモニタ\n\nデバイスの`Serial.print`を出力します。  \n\n`\u003cdevice-port\u003e`にデバイスのシリアルポートを指定して実行します。  \n\n```sh\nopniz monitor \u003cdevice-port\u003e\n```\n\n### `list`: ボードリスト表示\n\nデバイスをPCへ接続した状態で実行するとボード情報（port等）が表示されます。\n\n```sh\n$ opniz list\nシリアルポート Protocol タイプ               Board Name      FQBN                       Core\nCOM1          serial   Serial Port         Unknown\nCOM2          serial   Serial Port (USB)   Unknown\nCOM3          serial   Serial Port (USB)   TAMC Termod S3  esp32:esp32:tamc_termod_s3 esp32:esp32\n```\n\n### `arduino`: Arduino CLI直接実行\n\nArduino CLIを直接実行します。  \nArduino CLIコマンドをダブルクォーテーションで括って実行します。  \n\n```sh\nopniz arduino \"\u003carduino-cli command\u003e\"\n```\n\n```sh\n// example\n$ opniz arduino \"version\"\n$ opniz arduino \"lib list\"\n```\n\n\n\n## 関連リポジトリ\n\n* [opniz SDK for Node.js](https://github.com/miso-develop/opniz-sdk-nodejs)\n\t* opnizデバイスをNode.jsから遠隔制御するためのSDK\n* [opniz Arduino Library for M5Unified](https://github.com/miso-develop/opniz-arduino-m5unified)\n\t* M5Unified向けArduinoライブラリ\n* [opniz Server](https://github.com/miso-develop/opniz-server)\n\t* opniz Node.js SDKやopnizデバイスからのJSON RPCメッセージを中継するWebSocketサーバ\n\n\n\n## ライセンス\n\n[MIT](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmiso-develop%2Fopniz-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmiso-develop%2Fopniz-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmiso-develop%2Fopniz-cli/lists"}