Skip to content

extenv/initly

Repository files navigation

Initly

Initly is a lightweight scaffolding tool to quickly generate structure project.

🚀 Features

  • Generate project structures instantly from a simple .structure file
  • Supports nested folders and file content
  • Supports CLI

📦 Installation

bun add initly

OR

npm i initly

🧩 Example Usage

1. Create a .structure file

$ src/app.js
 console.log("Hello world!"); // your content
#
$ README.md
 This is a test project.  // your content
#

2. Run Initly

import { initly } from 'initly';

// Without logs (default)
initly('path/template.structure');

// With logs
initly('path/template.structure', { logs: true });

3. Result

├─ src/
│  └─ app.js
└─ README.md

✅ Key Points

  1. Each $ starts a new file or folder.
  2. The content for files goes between $ and #.
  3. Folders don’t need content; just write the $ folder/ line.
  4. File need format
$ folder/index.js
  <content>
#
  1. # must be used to mark the end of file content, otherwise Initly won’t know where the content stops.

🖥️ CLI Usage

Initly can also be used directly from the command line.

✔️ Basic Command

bunx initly <path-to-structure>

✔️ With Logging

bunx initly <path-to-structure> --log

✔️ Show Help Menu

bunx initly --help

©2025 Extenv.

About

Lightweight scaffolding tool to quickly generate structure project.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published