Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/a-kenji/flake-edit

Edit your flake inputs with ease.
https://github.com/a-kenji/flake-edit

cli flakes library nix rust

Last synced: 29 days ago
JSON representation

Edit your flake inputs with ease.

Host: GitHub
URL: https://github.com/a-kenji/flake-edit
Owner: a-kenji
License: mit
Created: 2023-10-06T21:58:29.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-09-26T13:26:51.000Z (about 1 month ago)
Last Synced: 2024-09-28T09:21:24.145Z (about 1 month ago)
Topics: cli, flakes, library, nix, rust
Language: Rust
Homepage:
Size: 3.67 MB
Stars: 25
Watchers: 1
Forks: 0
Open Issues: 21
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # `$ flake-edit` - edit your flake inputs with ease

[![Built with Nix](https://img.shields.io/static/v1?label=built%20with&message=nix&color=5277C3&logo=nixos&style=flat-square&logoColor=ffffff)](https://builtwithnix.org)

[![Crates](https://img.shields.io/crates/v/flake-edit?style=flat-square)](https://crates.io/crates/flake-edit)

[![Documentation](https://img.shields.io/badge/flake_edit-documentation-fc0060?style=flat-square)](https://docs.rs/flake-edit)

[![Matrix Chat Room](https://img.shields.io/badge/chat-on%20matrix-1d7e64?logo=matrix&style=flat-square)](https://matrix.to/#/#flake-edit:matrix.org)

- [`$ flake-edit` - edit your flake inputs with ease](#flake-edit-edit-your-flake-inputs-with-ease)

  - [`$ flake-edit` - usage](#-flake-edit---usage)

    - [`$ flake-edit add`](#-flake-edit-add)

    - [`$ flake-edit remove`](#-flake-edit-remove)

    - [`$ flake-edit update`](#-flake-edit-update)

    - [`$ flake-edit list`](#-flake-edit-list)

    - [`$ flake-edit pin`](#-flake-edit-pin)

  - [As a library](#as-a-library)

  - [Status](#status)

  - [License](#license)

## `$ flake-edit` - usage

`flake-edit` has the following cli interface:

```

Edit your flake inputs with ease.

Usage: flake-edit [OPTIONS] 

Commands:

  add

          Add a new flake reference

  remove

          Remove a specific flake reference based on its id

  list

          List flake inputs

  update

          Update inputs to their latest specified release

  pin

          Pin inputs to their current or a specified rev

  help

          Print this message or the help of the given subcommand(s)

Options:

      --flake 

          Location of the `flake.nix` file, that will be used

      --diff

          Print a diff of the changes, will set the apply flag to false

      --apply

          Whether to apply possible changes

  -h, --help

          Print help

  -V, --version

          Print version

```

### `$ flake-edit add`

```

Add a new flake reference

Usage: flake-edit add [OPTIONS] [ID] [URI]

Arguments:

  [ID]

          The name of an input attribute

  [URI]

          The uri that should be added to the input

Options:

      --ref-or-rev 

          Pin to a specific ref_or_rev

  -n, --no-flake

          The input itself is not a flake

  -h, --help

          Print help

```

For some types, the id will be automatically inferred.

![flake-edit add example](https://vhs.charm.sh/vhs-iJiVTOvSd8V9WEl79Ie68.gif)

For some inputs, the uri can be put in directly and the id and type will be inferred.

![flake-edit add inferred example](https://vhs.charm.sh/vhs-3RsaCQO9CAznelPup2kDgV.gif

)

### `$ flake-edit remove`

```

Remove a specific flake reference based on its id

Usage: flake-edit remove [ID]

Arguments:

  [ID]

          

Options:

  -h, --help

          Print help

```

![flake-edit remove example](https://vhs.charm.sh/vhs-1Uo70AaoEMuYh2UR1JVARD.gif)

### `$ flake-edit update`

```

Update inputs to their latest specified release

Usage: flake-edit update [OPTIONS] [ID]

Arguments:

  [ID]

          The id of an input attribute. If omitted will update all inputs

Options:

      --init

          Whether the latest semver release of the remote should be used even thought the release itself isn't yet pinned to a specific release

  -h, --help

          Print help

```

![flake-edit update example](https://vhs.charm.sh/vhs-289dZ9Y9cAYRkdSWtd4hT6.gif)

### `$ flake-edit list`

```

List flake inputs

Usage: flake-edit list [OPTIONS]

Options:

      --format 

          [default: detailed]

  -h, --help

          Print help

```

List the outputs, that are specified inside the inputs attribute.

![flake-edit list example](https://vhs.charm.sh/vhs-2ZSgdhkzBe3eoxuYtM1JL6.gif)

List the outputs, that are specified inside the inputs attribute, in json format.

![flake-edit list example](https://vhs.charm.sh/vhs-35E6eiL63lFTSC70rQyE1Y.gif)

### `$ flake-edit pin`

```

Pin inputs to their current or a specified rev

Usage: flake-edit pin  [REV]

Arguments:

  

          The id of an input attribute

  [REV]

          Optionally specify a rev for the inputs attribute

Options:

  -h, --help

          Print help

```

![flake-edit pin](https://vhs.charm.sh/vhs-629lX7LqP4MS1aHffb4Ufh.gif)

Pin a specific input to it's current revision (rev).

## As a library

Add `flake-edit` as a library by running:

```

cargo add flake-edit --no-default-features

```

Be aware that the `lib` interface is still unstable.

Though we are already happy to get feedback.

## Status

> [!NOTE]

> This project is currently in active development and should be considered a work in progress.

> The goal of `flake-edit` is to provide a robust and well-tested interface to flake inputs.

> Many edge cases are not covered yet, if you find any issues please consider opening an issue, or a pr.

> And we would be happy for feedback of the cli interface especially.

## Contributing

We welcome contributions from the community!

Check out the [Contributing Guidelines](./doc/CONTRIBUTING.md) on how to get started.

## Release Notes

Stay updated with the latest changes by viewing the [Changelog](./CHANGELOG.md).

## License

MIT