{"id":13566193,"url":"https://github.com/balpan-rs/balpan","last_synced_at":"2025-04-03T23:31:19.347Z","repository":{"id":171389259,"uuid":"647871462","full_name":"balpan-rs/balpan","owner":"balpan-rs","description":"Simple CLI Tool that supports your onboarding for a journey on source code.","archived":false,"fork":false,"pushed_at":"2024-03-19T12:08:10.000Z","size":339,"stargazers_count":37,"open_issues_count":21,"forks_count":7,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-04T20:42:18.517Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/balpan-rs.png","metadata":{"files":{"readme":"README.ko.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2023-05-31T17:47:36.000Z","updated_at":"2024-06-07T23:21:34.000Z","dependencies_parsed_at":"2024-01-19T07:09:25.599Z","dependency_job_id":"b5857961-7515-4243-ac8e-9a2602b20c2b","html_url":"https://github.com/balpan-rs/balpan","commit_stats":null,"previous_names":["balpan-rs/balpan"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/balpan-rs%2Fbalpan","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/balpan-rs%2Fbalpan/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/balpan-rs%2Fbalpan/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/balpan-rs%2Fbalpan/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/balpan-rs","download_url":"https://codeload.github.com/balpan-rs/balpan/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247097746,"owners_count":20883125,"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-08-01T13:02:04.186Z","updated_at":"2025-04-03T23:31:15.482Z","avatar_url":"https://github.com/balpan-rs.png","language":"Rust","funding_links":[],"categories":["Rust"],"sub_categories":[],"readme":"\n\n\u003cdiv align=\"center\"\u003e\n\n  \u003ch1\u003eBalpan CLI\u003c/h1\u003e\n  \u003ch5\u003e오픈소스 생태계에 기여하고자 하는 사람들의 온보딩을 돕는 \"발판\"\u003c/h5\u003e\n  \u003ch6\u003e오픈소스 프로젝트의 가독성을 높이고, 누구나 기여할 수 있도록 하자\u003c/h6\u003e\n\n[![Rust](https://img.shields.io/badge/Rust-000000?style=for-the-badge\u0026logo=rust\u0026logoColor=white)](https://www.rust-lang.org/)\n![Work In Progress](https://img.shields.io/badge/Work%20In%20Progress-orange?style=for-the-badge)\n\n\u003c/div\u003e\n\n## Table of Contents\n\n- [Introduction](#introduction)\n- [Installation](#installation)\n  - [Requirements](#requirements)\n  - [Install using homebrew](#brew)\n  - [Install using cargo](#cargo)\n  - [Quickstart](#quickstart)\n- [Features](#features)\n  - [Supported Language](#supported-languages)\n  - [`balpan init`](#balpan-init)\n\n## Introduction\u003ca name=\"introduction\"\u003e\u003c/a\u003e\n\n**balpan**은 오픈소스 생태계에 기여하고자 하는 사람들의 온보딩을 돕는 **발판** 이라는 의미로 시작했습니다. ([🔗](https://m.khan.co.kr/national/national-general/article/202109152114035#c2b))\n\n**balpan**은 [treesitter](https://tree-sitter.github.io)를 이용해서 소스코드를 트리 구조로 분석하여 시각화하고, 능동적으로 소스코드를 읽는 사람들에게는 좀 더 진입장벽을 낮추는 것을 목표로 합니다.\n\n책을 읽을 때도 줄을 치면서 읽듯이, 소스코드를 읽을때도 역시 책갈피 관리하듯이 읽을 수 있도록 하는 것부터 시작합니다.\n\n### Disclaimer\n\n* 트리시터를 설치하는 문제를 부분적으로 해결하기 위해 [helix](https://github.com/helix-editor/helix) 소스코드의 일부를 사용했습니다.\n  * 관련 코드: [config.rs](https://github.com/malkoG/balpan/blob/main/src/config.rs), [grammar.rs](https://github.com/malkoG/balpan/blob/main/src/grammar.rs), [lib.rs](https://github.com/malkoG/balpan/blob/main/src/lib.rs)\n\n## Installation\u003ca name=\"installation\"\u003e\u003c/a\u003e\n\n### Requirements\u003ca name=\"requirements\"\u003e\u003c/a\u003e\n\n- OS: Linux/macOS\n- Cargo (cargo를 이용해서 설치하는 경우)\n\n### Install using homebrew\u003ca name=\"brew\"\u003e\u003c/a\u003e\n\n```bash\n$ brew install malkoG/x/balpan\n```\n* ⚠️ 당장은 homebrew brew를 이용해서 설치하는 경우 `0.1.1` 릴리즈만 설치될 수 있습니다.\n  * 릴리즈를 출시할때마다 homebrew에 배포하는 과정을 자동화하는 방법은 알아보고 있는 중입니다.\n\n### Install using cargo\u003ca name=\"cargo\"\u003e\u003c/a\u003e\n\n```bash\n$ cargo install --path .\n```\n\n### Quickstart\u003ca name=\"quickstart\"\u003e\u003c/a\u003e\n\n**balpan**의 모든 명령어들은 소스코드를 트리구조의 형태로 분석하기 위해 treesitter 기반으로 생성된 파서를 이용합니다.  \n**balpan**의 각 명령어를 사용하기 전에 분석하고자 하는 리포지토리의 홈 디텍토리에서 아래의 명령어를 실행해주세요.\n\n```bash\n$ balpan init\n```\n\n## Features\u003ca name=\"features\"\u003e\u003c/a\u003e\n\n### Supported Languages\u003ca name=\"supported-languages\"\u003e\u003c/a\u003e\n\n당장은 지원하는 언어가 많이 없지만, 트리시터가 지원하는 언어라면 모두 지원할 수 있도록 하는 것을 지향합니다.\n\n- Rust \n- Python\n- Ruby\n\n### `balpan init`\u003ca name=\"balpan-init\"\u003e\u003c/a\u003e\n\n![balpan init demo animation](./assets/balpan-init-demo.gif)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbalpan-rs%2Fbalpan","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbalpan-rs%2Fbalpan","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbalpan-rs%2Fbalpan/lists"}