# kiki

**Repository Path**: hpstream/kiki

## Basic Information

- **Project Name**: kiki
- **Description**: 用来同步语雀文章
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 2
- **Created**: 2021-06-26
- **Last Updated**: 2022-06-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## BigBird 
**功能：**
1. 可以同步语雀文档到本地
2. 上传文档到语雀仓库

## 安装
> npm i @hpstream/kiki -g
```
// 执行 bb 或者 bigbird 
Commands:
  login              登录语雀
  save|s <path>      保存文档
  list|ls [options]  查看文档
  cm|compression [options]  压缩图片的功能
  help [command]     display help for command
```

## 语雀授权
npm login

## 文章下载
>  bb ls --help
```
Options:
  -a, --all          是否下载全部文档 (default: false)
  -p, --path <path>  存在在那个文件夹 (default: "")
  -h, --help         display help for command

```

## 保存文章
> bb s --help

```
Options:
  -p, --path <path>  保存文章的路径 (default: "")
  -h, --help         display help for command
```
## 压缩图片
> bb cm --help
```
Options:
  -c, --rename       是否添加名称后缀.min (default: false)
  -p, --path <path>  压缩哪个文件夹 (default: "")
  -h, --help         display help for command
```

 ## 存在问题
 1. markdown 如果包含图片，那么图片上传无法正确现实
 2. 如果出现权限问题，请使用sudo 



### 语雀api使用总结

> https://www.yuque.com/yuque/developer/api

语雀接口主要分支四部分：
1. 获取用户基础信息
```
Get /user
可以获取到主要信息,id(119800);login(hpstream)

GET /users/:login
# 或
GET /users/:id
得到login,id 通过上面接口也可以获取到基础信息


```
2. 获取组织信息
```
GET /users/:login/groups
# 或
GET /users/:id/groups

获取团队和组织信息

主要获取返回信息
{
  id: 29364379,
  login: 'swmudr',
  name: '学习记录',
}

```
3. 获取个人知识库信息
   
```
# for User
GET /users/:login/repos
# for Group
GET /groups/:login/repos

# 或
GET /users/:id/repos
GET /groups/:id/repos

主要返回结果：
{
  id: 28696178,
  type: 'Book',
  slug: 'ag2ub5',
  name: '新人指南',
}
```

https://www.yuque.com/yuque/developer/doc#684fb2c5