Home

Awesome

<div align="center"> <a href="https://github.com/kaixinbaba/hg-tui"> <img src="doc/img/logo.png" alt="Logo" width="80" height="80"> </a> <h3 align="center">hg-tui</h3> <p align="center"> 在命令行里浏览、搜索、访问 <a href="https://github.com/521xueweihan/HelloGitHub">HelloGitHub</a> 的开源项目。 <br /> <a href="doc/instruction.md"><strong>使用说明 »</strong></a> <br /> <br /> <a href="https://cdn.jsdelivr.net/gh/521xueweihan/img_logo@main/logo/weixin.png"><img src="https://img.shields.io/badge/Talk-%E5%BE%AE%E4%BF%A1%E7%BE%A4-brightgreen.svg?style=popout-square" alt="WeiXin"></a> <a href="https://github.com/kaixinbaba/hg-tui/stargazers"><img src="https://img.shields.io/github/stars/kaixinbaba/hg-tui.svg?style=popout-square" alt="GitHub stars"></a> <a href="https://github.com/kaixinbaba/hg-tui/issues"><img src="https://img.shields.io/github/issues/kaixinbaba/hg-tui.svg?style=popout-square" alt="GitHub issues"></a> <a href="https://weibo.com/hellogithub"><img src="https://img.shields.io/badge/%E6%96%B0%E6%B5%AA-Weibo-red.svg?style=popout-square" alt="Sina Weibo"></a> </p> </div>

一、介绍

<p align="center"><img src='doc/img/cover.png' style="max-width:80%; max-height=80%;"></img></p>

在终端轻松浏览 HelloGitHub 的命令行工具。

快速上手指南:

  1. 安装后启动的命令:hg-tui
  2. 进入程序后,默认展示最新一期月刊
  3. 可通过 k(Up)/j(Down) 上下移动光标,按下 o 查看详细介绍
  4. 同时按下 Ctrl+k(Up) 进入搜索模式,输入关键字即可搜索项目
  5. 遇到问题,同时按下 Ctrl+h 获取帮助
  6. 按下 qCtrl+c 键退出程序

二、安装

第一种:直接下载使用

下载就能用!Windows、Linux、macOS 系统对应的可执行文件,点击下载

<p align="center"><img src='doc/img/releases.png' style="max-width:80%; max-height=80%;"></img></p>

第二种:通过源码安装

$ git clone https://github.com/kaixinbaba/hg-tui.git
$ cd hg-tui
$ cargo install --path .
$ hgtui

查看帮助

$ hgtui --help

查看内置配色方案 预览,如果你有更好的配色方案或想法可以给我提 issue 噢

$ hgtui --show-themes

三、快捷键

基本:

组合快捷键:

高级搜索:

四、技术

项目中使用到的技术:

目录结构:

src
├── app.rs	// 统一管理整个应用的状态
├── cli.rs	// 命令行解析
├── draw.rs	// 绘制 UI
├── events.rs   // UI 事件、输入事件、通知
├── fetch.rs	// HTTP 请求
├── main.rs	// 入口
├── parse.rs	// HTML 解析
├── utils.rs	// 工具
└── widget 	// 自定义组件
    ├── ...

五、更新计划

欢迎加入我们一起贡献。

feature plan

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

联系我