{"id":25072676,"url":"https://github.com/andmev/stegjs","last_synced_at":"2025-06-29T18:37:03.876Z","repository":{"id":9707070,"uuid":"63058232","full_name":"andmev/stegjs","owner":"andmev","description":"This application enables users to encrypt/encode messages into PNG images. It works in two modes, encoding and decoding.","archived":false,"fork":false,"pushed_at":"2024-10-02T15:02:23.000Z","size":1935,"stargazers_count":23,"open_issues_count":0,"forks_count":3,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-01T07:39:01.866Z","etag":null,"topics":["cli","cryptography","image","png","secret-messages","steganography"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/andmev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-07-11T10:17:54.000Z","updated_at":"2024-10-20T13:44:36.000Z","dependencies_parsed_at":"2024-10-23T02:00:11.972Z","dependency_job_id":null,"html_url":"https://github.com/andmev/stegjs","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andmev%2Fstegjs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andmev%2Fstegjs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andmev%2Fstegjs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andmev%2Fstegjs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andmev","download_url":"https://codeload.github.com/andmev/stegjs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248510003,"owners_count":21116131,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","cryptography","image","png","secret-messages","steganography"],"created_at":"2025-02-06T22:32:33.133Z","updated_at":"2025-04-14T22:11:50.441Z","avatar_url":"https://github.com/andmev.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# stegjs\n\n[![npm](https://img.shields.io/npm/v/stegjs.svg?maxAge=1)](https://www.npmjs.com/package/stegjs) [![npm](https://img.shields.io/npm/dt/stegjs.svg?maxAge=1)](https://www.npmjs.com/package/stegjs) ![Steg.js Test workflow](https://github.com/andmev/stegjs/actions/workflows/test.yml/badge.svg)\n[![npm](https://img.shields.io/npm/l/stegjs.svg?maxAge=1)](https://www.npmjs.com/package/stegjs)\n\n\u003e A Node.js module and command-line utility for performing steganographic encoding in PNG images. This application enables the secure transmission of secret messages, passwords, or other critical information by embedding data within images.\n\n## Installation\n\nTo install globally you should enter in terminal window the following command:\n\n```sh\n$ npm i -g stegjs\n```\n\nTo install locally you should enter in terminal window the following command:\n\n```sh\n$ npm i stegjs\n```\n\n## Help\n\n### Usage as Node.js module\n\n```js\nconst steg = require('stegjs')\n\n// Encode message\nconst response = steg.encode('img.png', 'my_secret_pass', '1x1', './secrets/go.png')\nconsole.log(response) // -\u003e { message: 'my_secret_pass', pattern: '1x1', output: './secrets/go.png' }\n\n// Decode message\nconst response = steg.decode('./secrets/go.png')\nconsole.log(response) // -\u003e { message: 'my_secret_pass', pattern: '1x1' }\n```\n\n### Usage as CLI\n\n```sh\n$ stegjs --help\n\n  Usage: stegjs \u003cimage or url\u003e.png [mode] [message] [step] [output]\n\n  Encrypt you message to PNG image.\n\n  Options:\n\n    -h, --help     output usage information\n    -V, --version  output the version number\n    -e, --encode   Change program mode to encode file\n    -d, --decode   Change program mode to decode file\n```\n\nSyntax information:\n\n```\n[mode]\t\tone of the two modes\n[message]\tthe message you want to encrypt\n[step]\t\tpattern of the distribution message bits in the alpha channel of the image\n[output]\tpath where to save the image with the encoded message\n```\n\n## Examples\n\nThe program works in two modes, encrypt and decrypt messages.\n\n#### Encode\n\nTo encrypt a message use one of the following commands:\n\n```sh\n$ npx stegjs img.png -e \"Meeting tonight at midnight under the light.\" 5x5\n$ npx stegjs https://upload.wikimedia.org/wikipedia/commons/4/47/PNG_transparency_demonstration_1.png -e \"my_secret_pass\" 1x1 ./secrets/go.png\n$ npx stegjs nyan.png -e \"🐱\" 2x1\n```\n\nAfter that in the console, you will see the full path to the output image, message and pattern.\n\n```sh\n/Users/you/secrets/out.png has been encoded\nmessage: 🐱\npattern: 2x1\n```\n\n#### Decode\n\nTo receive an encrypted message, specify the path to the image with the secret message and add the flag `-d`.\n\n```sh\n$ npx stegjs out.png -d\n```\n\nAfter that in the console, you will see the information contained in the encrypted image.\n\n```sh\nout.png was decoded\nmessage: 🐱\npattern: 2x1\n```\n\n## License\n\n[MIT][license] © [Andrey Medvedev][website]\n\n[license]: http://showalicense.com/?fullname=Andrey%20Medvedev%20%3Ca.medvedev@me.com%3E\u0026year=2016#license-mit\n[website]: https://github.com/andmev\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandmev%2Fstegjs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandmev%2Fstegjs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandmev%2Fstegjs/lists"}