KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #typescript #developer-tools #claude-code #ai-agent #codex #deepseek-harness #ai-agents #cli #react #mcp

libmake

★ 30 Open GitHub ↗

A code generator to reduce repetitive tasks and build high-quality Rust libraries. 🦀

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# LibMake

A code generator to reduce repetitive tasks and build high-quality Rust libraries.

*Part of the [Mini Functions][00] family of libraries.*

<center>

![Banner of Libmake][banner]

[![Made With Rust][made-with-rust-badge]][13] [![Crates.io][crates-badge]][08] [![Lib.rs][libs-badge]][10] [![Docs.rs][docs-badge]][09] [![License][license-badge]][03] [![Codecov][codecov-badge]][14]

• [Website][01] • [Documentation][09] • [Report Bug][04] • [Request Feature][04] • [Contributing Guidelines][05]

</center>

![divider][divider]

## Overview

`LibMake` is a tool designed to quickly help creating high-quality Rust libraries by generating a set of pre-filled and pre-defined templated files. This opinionated boilerplate scaffolding tool aims to greatly reduce development time and minimizes repetitive tasks, allowing you to focus on your business logic while enforcing standards, best practices, consistency, and providing style guides for your library.

With `LibMake`, you can easily generate a new Rust library code base structure with all the necessary files, layouts, build configurations, code, tests, benchmarks, documentation, and much more in a matter of seconds.

The library is designed to be used as a command-line tool. It is available on [Crates.io][07] and [Lib.rs][08].

## Table of Contents

- [LibMake](#libmake)
  - [Overview](#overview)
  - [Table of Contents](#table-of-contents)
  - [Features](#features)
  - [Getting Started](#getting-started)
    - [Prerequisites](#prerequisites)
    - [Installation](#installation)
    - [Requirements](#requirements)
      - [Tier 1 platforms](#tier-1-platforms)
      - [Tier 2 platforms](#tier-2-platforms)
    - [Documentation](#documentation)
  - [Usage](#usage)
    - [Command-line interface](#command-line-interface)
      - [Passing a configuration file](#passing-a-configuration-file)
        - [Generate a new library using a CSV file](#generate-a-new-library-using-a-csv-file)
        - [Generate a new library using an INI file](#generate-a-new-library-using-an-ini-file)
        - [Generate a new library using a JSON file](#generate-a-new-library-using-a-json-file)
        - [Generate a new library using a TOML file](#generate-a-new-library-using-a-toml-file)
        - [Generate a new library using a YAML file](#generate-a-new-library-using-a-yaml-file)
      - [Generate a new library using the command-line interface (CLI) directly](#generate-a-new-library-using-the-command-line-interface-cli-directly)
    - [Examples](#examples)
  - [Semantic Versioning Policy](#semantic-versioning-policy)
  - [License](#license)
  - [Contribution](#contribution)
  - [Acknowledgements](#acknowledgements)

## Features

`LibMake` offers the following features and benefits:

- **Simplicity**: Create Rust libraries effortlessly via CLI or configuration files in CSV, JSON, TOML, or YAML.
- **Speed**: Instantly scaffold new libraries with a standard structure and essential boilerplate.
- **Automation**: Generate predefined GitHub Actions workflows for streamlined development and testing.
- **Foundation**: Jumpstart your project with automatically generated functions, methods, and macros.
- **Standards**: Embrace best practices from the start with starter documentation, tests, and benchmarks.

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

You will need Rust and Cargo installed on your system. If you don't have them installed, you can install them from the official Rust website.

It takes just a few seconds to get up and running with `LibMake`.

### Installation

Once you have the Rust toolchain installed, you can install `LibMake`
using the following command:

```shell
cargo install libmake
```

You can then run the help command to see the available options:

```shell
libmake --help
```

### Requirements

The minimum supported Rust toolchain version is currently Rust `1.60` or later (stable).

`LibMake` is supported and has been tested on the following platforms:

#### Tier 1 platforms

Rust Tier 1 targets are officially supported and guaranteed to work.

| | Operating System | Target | Description |
| --- | --- | --- | --- |
| ✅ | Linux   | aarch64-unknown-linux-gnu | 64-bit Linux systems on ARM architecture |
| ✅ | Linux   | i686-unknown-linux-gnu | 32-bit Linux (kernel 3.2+, glibc 2.17+) |
| ✅ | Linux   | x86_64-unknown-linux-gnu | 64-bit Linux (kernel 2.6.32+, glibc 2.11+) |
| ✅ | macOS   | x86_64-apple-darwin | 64-bit macOS (10.7 Lion or later) |
| ✅ | Windows | i686-pc-windows-gnu | 32-bit Windows (7 or later) |
| ✅ | Windows | i686-pc-windows-msvc | 32-bit Windows (7 or later) |
| ✅ | Windows | x86_64-pc-windows-gnu | 64-bit Windows (7 or later) |
| ✅ | Windows | x86_64-pc-windows-msvc | 64-bit Windows (7 or later) |

#### Tier 2 platforms

Rust Tier 2 targets are supported for building, but not necessarily running.

| | Operating System | Target | Description |
| --- | --- | --- | --- |
| ✅ | Linux   | aarch64-unknown-linux-musl | 64-bit Linux systems on ARM architecture |
| ✅ | Linux   | arm-unknown-linux-gnueabi | ARMv6 Linux (kernel 3.2, glibc 2.17) |
| ✅ | Linux   | arm-unknown-linux-gnueabihf | ARMv7 Linux, hardfloat (kernel 3.2, glibc 2.17) |
| ✅ | Linux   | armv7-unknown-linux-gnueabihf | ARMv7 Linux, hardfloat (kernel 3.2, glibc 2.17) |
| ✅ | macOS   | aarch64-apple-darwin | 64-bit macOS (10.7 Lion or later) |
| ✅ | Windows | aarch64-pc-windows-msvc | 64-bit Windows (7 or later) |

The [GitHub Actions][11] shows the platforms in which the `LibMake`
library tests are run.

Should you encounter any issues with the library on any of the above
platforms, please [report a bug][04]. We will do our best to resolve the
issue as soon as possible. If you would like to contribute to help us to
support additional platforms, please submit a pull request.

### Documentation

**Info:** Do check out our [website][01] for more information. You can find our documentation on [docs.rs][09], [lib.rs][10] and [crates.io][08].

## Usage

### Command-line interface

`LibMake` provides a command-line interface to generate a new library project. There are a few options available to help you get started.

#### Passing a configuration file

##### Generate a new library using a CSV file

The following command generates a library template from a CSV file.

Have a look at the `tests/data/mylibrary.csv` file for an example and
feel free to use it for your own library as a template.

```shell
libmake file --csv tests/data/mylibrary.csv
```