You're Invited:Meet the Socket Team at BlackHat and DEF CON in Las Vegas, Aug 4-6.RSVP

intradoc

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

intradoc

In-place document content replacer CLI utility.

1.1.2
latest
Version published
Weekly downloads
246
-1.99%
Maintainers
1
Weekly downloads
 
Created

intradoc


release-badge ci-badge coverage-badge dependency-badge security-badge

code-style-badge commit-style-badge release-workflow-badge

license-badge contribution-badge

Update your docs in-place.

A simple, in-place document content replacer CLI utility,
which works by replacing placeholder texts within your files.

🤔 Why?

  • Keep your documents up-to-date during the SDLC, especially during releases without creating additional or separate in-between and temp files.
  • Avoid errors and improve consistency by using simple comment placeholders and populate them with new data.
  • Save time and effort by automating the process of replacing API, usage, and other information within your files instead of you updating them manually.

📦 Installation

npm i intradoc

☕ Usage

$ intradoc <flags> <input>
$ intradoc <input> <flags>

$ intradoc <flags> -f [...files] -d [...data]
$ intradoc <flags> [...files] [data]

$ intradoc -f [...files] -d [...data] <flags>
$ intradoc [...files] [data] <flags>

💻 CLI

Usage:
  $ intradoc <flags> <input>
  $ intradoc <input> <flags>

  $ intradoc <flags> -f [...files] -d [...data]
  $ intradoc <flags> [...files] [data]

  $ intradoc -f [...files] -d [...data] <flags>
  $ intradoc [...files] [data] <flags>

Examples:
  $ intradoc -f README.md -d data.json

  $ intradoc README.md data.yml

Options:
  -f, --file, --files   file(s) to process
  -d, --data            data to use

  -v, --version   output the version number
  -h, --help      display help for intradoc

🍻 Contribution

Any contribution is highly appreciated. To get going, check out the contribution guidelines.

Thank you!

©️ License

MIT @ Richard King

FAQs

Package last updated on 25 Apr 2023

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts