# chimpers

> hide files in text

Latest version **2.0.0** (published 2026-03-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install chimpers
pnpm add chimpers
yarn add chimpers
bun add chimpers
```

## Health

**Score 55/100 (C)** — status: stable.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2026-03-04 |
| First published | 2022-12-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 58.1 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | reemo |
| Maintainers | r48n34 |
| Keywords | cipher, steganography, hacking, infosec |

## Links

- npm: https://www.npmjs.com/package/chimpers
- Repository: https://github.com/r48n34/chimpers
- Issues: https://github.com/r48n34/chimpers/issues
- npm.io page: https://npm.io/package/chimpers

## Dependencies (2)

- [file-type](https://npm.io/package/file-type.md) 16.5.4
- [clipboardy](https://npm.io/package/clipboardy.md) 2.3.0

## Alternatives

- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads

## Recent versions

- 2.0.0 (latest) — 2026-03-04
- 1.0.5 — 2023-05-31
- 1.0.4 — 2022-12-25
- 1.0.3 — 2022-12-16
- 1.0.2 — 2022-12-16
- 1.0.1 — 2022-12-16
- 1.0.0 — 2022-12-16

## README

# chimpers  
A nodejs library that Hide files / zip / images in text by hidden format.

<p align="left">

<a href="https://www.npmjs.com/package/chimpers"> <img src="https://img.shields.io/npm/v/chimpers" /> </a>
<a href="https://github.com/r48n34/chimpers"><img src="https://img.shields.io/github/actions/workflow/status/r48n34/chimpers/test.yml" /></a>

</p>

[Web Demo](https://chimpers-web.vercel.app/) | [chimpers npm](https://www.npmjs.com/package/chimpers) | [chimpers-web npm](https://www.npmjs.com/package/chimpers-web) | [Github](https://github.com/r48n34/chimpers)

## Install 
```bash
npm i chimpers
yarn add chimpers
```

## 2.0 Updates
1. The encrypt string is not require space ("").


## Notices
1. Hidden file is not encrypted currently. 
2. Do not attempt to hide large size file.
3. Single file that smaller than 4kb is recommended.

## Usage
```ts
import { addFileInText, decodeFile } from "chimpers"
import path from "path";

( async () => {

    const filePath = path.join(__dirname, "yo.zip")

    // Add files to text
    const text = addFileInText(
        "hello mate I am peter.", // Text to add files
        filePath,                 // Your txt / zip / file ... locations
        { copyToBoard: false }     // Optional: Will regarding text copy to your clipboard
    );
    
    // Decode regarding text
    await decodeFile(
        text,          // Encoded text string
        "hello",       // Output file name
        __dirname      // Output file path
    );

})()
```

## Utilis
```ts
// Hide files in text
function addFileInText(
    text: string,                 
    file_path: string,
    option?: AddFileInTextOptions
): string 

interface AddFileInTextOptions{
    copyToBoard?: boolean
}
```

```ts
// Decode hidden text and output a file
async function decodeFile(
    encodedText: string, 
    outputFileName: string = "decodedFile", 
    outputPath: string = process.cwd()
): Promise<Uint8Array> 
```

## Roadmap
- [ ] Encrypt passowrd options
- [ ] Better compress size
- [ ] Web npm packages

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