# duvet

**Repository Path**: mirrors_awslabs/duvet

## Basic Information

- **Project Name**: duvet
- **Description**: A requirements traceability tool
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-08-18
- **Last Updated**: 2026-03-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Duvet

Duvet is a tool that establishes a bidirectional link between implementation and specification. This practice is called [requirements traceability](https://en.wikipedia.org/wiki/Requirements_traceability), which is defined as:

> the ability to describe and follow the life of a requirement in both a forwards and backwards direction (i.e., from its origins, through its development and specification, to its subsequent deployment and use, and through periods of ongoing refinement and iteration in any of these phases)

## Quick Start

Before getting started, Duvet requires a [rust toolchain](https://www.rust-lang.org/tools/install).

1. Install command

    ```console
    $ cargo install duvet --locked
    ```

2. Initialize repository

    In this example, we are using Rust. However, Duvet can be used with any language.

    ```console
    $ duvet init --lang-rust --specification https://www.rfc-editor.org/rfc/rfc2324
    ```

3. Add a implementation comment in the project

    ```rust
    // src/lib.rs

    //= https://www.rfc-editor.org/rfc/rfc2324#section-2.1.1
    //# A coffee pot server MUST accept both the BREW and POST method
    //# equivalently.
    ```

4. Generate a report

    ```console
    $ duvet report
    ```

## Development

You must have `git lfs` installed. You can check this by running
```shell
git lfs version
```

### Building

```console
$ cargo xtask build
```

### Testing

```console
$ cargo xtask test
```

## Security

See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.

## License

This project is licensed under the Apache-2.0 License.