# fsctl

**Repository Path**: no-src/fsctl

## Basic Information

- **Project Name**: fsctl
- **Description**: fsctl是一种基于配置的文件操作和验证工具
- **Primary Language**: Go
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: https://github.com/no-src/fsctl
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-03-25
- **Last Updated**: 2023-11-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: 文件操作, 文件验证, testing-tools

## README

# fsctl

[![Build](https://img.shields.io/github/actions/workflow/status/no-src/fsctl/go.yml?branch=main)](https://github.com/no-src/fsctl/actions)
[![License](https://img.shields.io/github/license/no-src/fsctl)](https://github.com/no-src/fsctl/blob/main/LICENSE)
[![Go Reference](https://pkg.go.dev/badge/github.com/no-src/fsctl.svg)](https://pkg.go.dev/github.com/no-src/fsctl)
[![Go Report Card](https://goreportcard.com/badge/github.com/no-src/fsctl)](https://goreportcard.com/report/github.com/no-src/fsctl)
[![codecov](https://codecov.io/gh/no-src/fsctl/branch/main/graph/badge.svg?token=BTPKR8G6QI)](https://codecov.io/gh/no-src/fsctl)
[![Release](https://img.shields.io/github/v/release/no-src/fsctl)](https://github.com/no-src/fsctl/releases)

[English](README.md) | 简体中文

fsctl是一种基于配置的文件操作和验证工具

## 安装

首先需要确保已经安装了[Go](https://golang.google.cn/doc/install) (**版本必须是1.20+**)，
然后你就可以使用下面的命令来安装`fsctl`了

```bash
go install github.com/no-src/fsctl/...@latest
```

### 在Docker中运行

你可以使用[build-docker.sh](/scripts/build-docker.sh)脚本来构建docker镜像，首先你需要克隆本仓库并且`cd`到本仓库的根目录

```bash
$ ./scripts/build-docker.sh
```

或者使用以下命令直接从[DockerHub](https://hub.docker.com/r/nosrc/fsctl)中拉取docker镜像

```bash
$ docker pull nosrc/fsctl
```

更多关于发布与docker的脚本请参见[scripts](scripts)目录

## 快速开始

创建一个名为`fsctl.yaml`的配置文件，内容如下所示

```yaml
name: fsctl quick start example
init:
  - mkdir:
    source: ./source
  - mkdir:
    source: ./dest
  - print:
    input: init done
actions:
  - touch:
    source: ./source/hello
  - echo:
    source: ./source/hello
    input: Hello World
    append: false
  - cp:
    source: ./source/hello
    dest: ./dest/hello
  - is-equal:
    source: ./source/hello
    dest: ./dest/hello
    expect: true
  - is-equal-text:
    source: ./source/hello
    dest: |
      Hello World
    expect: true
clear:
  - rm:
    source: ./source
  - rm:
    source: ./dest
```

现在运行下面的命令就可以开始操作和验证文件了

```bash
$ fsctl -conf fsctl.yaml
```

更多`fsctl`的配置示例，请参见[example](/command/example)目录

## 更多信息

### 帮助信息

```bash
$ fsctl -h
```

### 版本信息

```bash
$ fsctl -v
```

### 关于信息

```bash
$ fsctl -about
```