# imgcook-cli

**Repository Path**: mirrors_yorkie/imgcook-cli

## Basic Information

- **Project Name**: imgcook-cli
- **Description**: Using Imgcook force in your terminal
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-10-22
- **Last Updated**: 2026-05-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# imgcook-cli

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/imgcook/imgcook-cli/blob/master/LICENSE)
[![GitHub tag](https://img.shields.io/github/tag/imgcook/imgcook-cli.svg)]()
[![Build Status](https://travis-ci.org/imgcook/imgcook-cli.svg?branch=master)](https://travis-ci.org/imgcook/imgcook-cli)
[![npm dm](https://img.shields.io/npm/dm/@imgcook/cli)](https://www.npmjs.com/package/@imgcook/cli)
[![GitHub repo size](https://img.shields.io/github/repo-size/imgcook/imgcook-cli)]()

## 概述

imgcook-cli 可以结合 Plugin 的能力一键将 imgcook 平台生成的代码产物放置到你的本地项目工程里，无缝融合到你的研发流程，如果你有对 imgcook 生成代码的产物有加工需求（比如自动上传图片到自己的图床、文件目录转换等），imgcook-cli 是你非常好的选择。

## 安装
> imgcook-cli 安装依赖 Node.js 和 NPM，建议使用 Node.js 版本 9.x


```shell
# npm
npm install -g @imgcook/cli
# yarn
yarn global add @imgcook/cli
```

## 使用

### 常用指令

#### imgcook config
> 用户设置配置，默认初始化生成官方配置


```shell
# 设置配置
imgcook config set

# 查看配置
imgcook config ls

# 直接打开配置文件编辑
imgcook config edit
```

> DSL 配置：<br/>
> React D2C Schema：41<br/>
> Vue 开发规范：29<br/>
> 微信小程序开发规范：21<br/>
> React 开发规范：12<br/>
> H5 标准开发规范：5<br/>
> Rax 标准开发规范：1<br/>
> <br/>
> accessId 获取：打开官网 https://www.imgcook.com 右上角头像 -> 个人页面 -> 左上方 Icon
> <br/><image width="396" src="https://gw.alicdn.com/tfs/TB1rFW3qeL2gK0jSZFmXXc7iXXa-1156-480.png">


#### imgcook pull
> 拉取模块代码


```shell
# 拉取某个模块代码到本地路径
imgcook pull <moduleId> --path <path>
# 例子
imgcook pull 17108 --path mod
```

#### imgcook install
> 安装 imgcook-cli 所需的 Plugin 


```shell
# 默认安装全部配置过的 Plugin
imgcook install

# 安装指定的 Plugin
imgcook install plugin --name <value>

# 例子
imgcook install plugin --name @imgcook/plugin-images
```

### 选项


#### imgcook --version
> 显示版本信息


```shell
imgcook --version
imgcook -v
```

#### imgcook --help
> 显示指令使用帮助


```shell
imgcook --help
imgcook -h
```

## License
[MIT](https://github.com/imgcook/imgcook-cli/blob/master/LICENSE)