# @nikitajs/file

> Provides Nikita actions to work with files.

Latest version **1.0.0-alpha.9** (published 2024-07-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install @nikitajs/file
pnpm add @nikitajs/file
yarn add @nikitajs/file
bun add @nikitajs/file
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0-alpha.9 |
| Published | 2024-07-27 |
| First published | 2021-02-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >= 10.0.0 |
| Dependencies | 8 |
| Unpacked size | 134.8 KB |
| Known vulnerabilities | 0 (+16 in 1 direct dependencies) |
| Install scripts | no |
| Author | David Worms <david@adaltas.com> |
| Maintainers | david |
| Keywords | nikita, build, cli, deploy, fs, install, masson, ssh, system, task |

## Links

- npm: https://www.npmjs.com/package/@nikitajs/file
- Repository: https://github.com/adaltas/node-nikita
- Homepage: https://nikita.js.org/
- Issues: https://github.com/adaltas/node-nikita/issues
- npm.io page: https://npm.io/package/@nikitajs/file

## Dependencies (8)

- [ini](https://npm.io/package/ini.md) ^4.1.3
- [cson](https://npm.io/package/cson.md) ^8.4.0
- [diff](https://npm.io/package/diff.md) ^5.2.0
- [mixme](https://npm.io/package/mixme.md) ^1.1.0
- [dedent](https://npm.io/package/dedent.md) ^1.5.3
- [xmldom](https://npm.io/package/xmldom.md) ^0.6.0
- [handlebars](https://npm.io/package/handlebars.md) ^4.7.8
- [xmlbuilder](https://npm.io/package/xmlbuilder.md) ^15.1.1

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 1.0.0-alpha.9 (latest) — 2024-07-27
- 1.0.0-alpha.8 — 2024-07-20
- 1.0.0-alpha.7 — 2024-06-13
- 1.0.0-alpha.6 — 2024-06-10
- 1.0.0-alpha.4 — 2023-12-22
- 1.0.0-alpha.3 — 2022-05-02
- 1.0.0-alpha.2 — 2021-08-30
- 1.0.0-alpha.1 — 2021-03-10
- 1.0.0-alpha.0 — 2021-02-03

## README

# Nikita "file" package

The "file" package provides Nikita actions to work with files.

## Usage

```js
import "@nikitajs/file/register";
import nikita from "@nikitajs/core";

const {$status} = await nikita.file.yaml({
  content: {
    preference: {
      color: "orange",
    },
  },
  target: "~/config.yml"
});
console.info("File was modified:", $status);
```

---
_Source: https://npm.io/package/@nikitajs/file · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._