{"id":44060903,"url":"https://github.com/tamadalab/kani","last_synced_at":"2026-02-08T01:36:04.410Z","repository":{"id":49493808,"uuid":"285447906","full_name":"tamadalab/kani","owner":"tamadalab","description":"A tool for supporting git/GitHub operation for the novice developers.","archived":false,"fork":false,"pushed_at":"2021-06-16T14:25:27.000Z","size":249,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-14T23:16:51.587Z","etag":null,"topics":["git","github","novice-guide"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tamadalab.png","metadata":{"files":{"readme":"README.ja.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}},"created_at":"2020-08-06T01:56:56.000Z","updated_at":"2021-06-16T14:25:07.000Z","dependencies_parsed_at":"2022-09-12T13:20:28.977Z","dependency_job_id":null,"html_url":"https://github.com/tamadalab/kani","commit_stats":null,"previous_names":["ma-sa321/kani"],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/tamadalab/kani","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tamadalab%2Fkani","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tamadalab%2Fkani/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tamadalab%2Fkani/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tamadalab%2Fkani/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tamadalab","download_url":"https://codeload.github.com/tamadalab/kani/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tamadalab%2Fkani/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29216092,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-08T00:10:47.190Z","status":"ssl_error","status_checked_at":"2026-02-08T00:10:43.589Z","response_time":63,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["git","github","novice-guide"],"created_at":"2026-02-08T01:36:03.629Z","updated_at":"2026-02-08T01:36:04.405Z","avatar_url":"https://github.com/tamadalab.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# :crab: kani\n\n初学者のためのGit/GitHub操作補助フレームワーク．\n\n[![License](https://img.shields.io/badge/License-CC0--1.0-blue?logo=spdx)](https://creativecommons.org/publicdomain/zero/1.0/)\n[![Version](https://img.shields.io/badge/Version-1.2.1-blue.svg)](https://github.com/tamadalab/kani/releases/tag/v1.2.1)\n[![DOI](https://zenodo.org/badge/285447906.svg)](https://zenodo.org/badge/latestdoi/285447906)\n\n[![tamada/brew/kani](https://img.shields.io/badge/Homebrew-tamadalab%2Fbrew%2Fkani-green?logo=homebrew)](https://github.com/tamadalab/homebrew-brew)\n\n[![Discussion](https://img.shields.io/badge/GitHub-Discussion-orange?logo=GitHub)](https://github.com/tamadalab/kani/discussions)\n\n## 本ツールは2020年度特別研究IIで作成\n\nhttps://github.com/tamadalab/2020bthesis_masuda\n\n### 実装機能概要\n- コンパイル時にcommit差分を比較し，規定値以上の変更があった場合commitを促す．\n- 連続したエラーが解消された時点で，commitを促す．\n- commitを促す際，add commit pushの簡易にhelp表示する．\n\n### 未修正点\n\n- エラー情報を蓄積するDBが1つに集約されているため，ファイルAのエラーが修正されないまま別ファイルを実行すると，ファイルAのエラー情報の影響を受ける．\n- コンパイルはgccとclangの場合と手動で制限している[該当ファイル](https://github.com/tamadalab/kani/blob/master/scripts/precmd_hook.sh)．\n- .gitフォルダが上位ディレクトリにない場合，.git無いよとエラー出る(操作には影響ない)．\n- 正直スパゲッティになってるファイルがある．\n\n\n## 評価実験用\n\n#### テンプレートリポジトリ\n\nhttps://github.com/tmdlab2020TestTeam/testTemplate\n\n#### GitHubClassroom[GitHub Classroomとは](http://takehiroman.hatenablog.com/entry/2016/03/31/135736)\nhttps://classroom.github.com/classrooms/73564814-tmdlab2020testteam-githubclassroom/assignments/tmdlab-test-team\n\n# kaniの機能詳細\n\n### 分析の一時停止/再開\n\n```sh\n$ git kani disable/enable\n```\n\n* `disable` で `PROJECT_ROOT/.kani/disable` ファイルが作成される．\n* `enable` を実行すると，`PROJECT_ROOT/.kani/disable` ファイルが削除される．\n\n### 分析対象から外す\n\n```sh\n$ git kani deinit\n```\n\n* `$HOME/.config/kani/projects`からプロジェクトのパスが削除される．\n\n\n## :anchor: Install\n\n### :beer: Homebrew\n\n```sh\n$ brew tap tamadalab/brew\n$ brew install kani\n```\n\n上記コマンドにて，以下のようなディレクトリが作成される．\nInstalling `kani` by Homebrew, the following directories are built.\n\n```sh\n/usr/local/Celler/kani\n├── README.md\n├── analyses\n│   ├── recommend.py (どういった条件でcommitを促すか決める所)\n│   └── commit_guide.txt (commitを促す際の文)\n├── bin\n│   └── git-kani\n└── scripts # utilities (hook functions)\n    ├── chpwd_hook.sh\n    ├── periodic_hook.sh\n    ├── precmd_hook.sh\n    ├── preexec_hook.sh\n    ├── find-project-dir.sh (現在のディレクトリからプロジェクトのルートを取得するスクリプト)\n    └── is-target-project.sh (現在のディレクトリのプロジェクトがkaniの分析対象かどうかを判定するスクリプト)\n```\n\n### Initialize `kani` on your environment.\n\nWrite the following line into your `~/.zshrc`.\n\n```sh\neval \"$(git kani init -)\"\n```\n\nhook関数については[この資料](https://qiita.com/mollifier/items/558712f1a93ee07e22e2)を参照してください．\n\n### Enabling `kani` on your project.\n\nType the following command.\n\n```sh\n$ git kani init\n```\n\n* 上記のコマンドで `.git` と同じディレクトリに `.kani` ディレクトリが作成される．\n    * `.kani` ディレクトリには，`analyses`ディレクトリにあるスクリプトがコピーされる．\n* `$HOME/.config/kani/projects` にプロジェクトのパスが追記される．\n\n* `PROJECT_ROOT/.kani` には，分析結果のデータを格納している．\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftamadalab%2Fkani","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftamadalab%2Fkani","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftamadalab%2Fkani/lists"}