Frequently Asked Questions

mkarchi is a powerful command-line tool that generates complete project structures from tree-format text files. It's designed to bridge the gap between AI code generation and your local filesystem.

Think of it as "Architecture as Code" - you define your project structure in a simple, visual format, and mkarchi creates all the directories and files for you.

mkarchi requires Python 3.6+ and can be installed via pip:

To upgrade to the latest version:

pip is Python's package installer and usually comes pre-installed with Python. To check if you have pip:

If pip is not installed, visit the official pip installation guide:

We strongly recommend using v0.1.7 (the latest version).

v0.1.7 includes important new features:

• -max=<kb> flag to control file size limits
• --no-max flag to include all file contents
• --no-ignore flag for complete project snapshots
• Bug fixes and performance improvements

Unless you have a specific reason to use v0.1.6, always install the latest version.

Older versions may contain:

• Bugs that have been fixed in newer releases
• Missing features that improve usability
• Security vulnerabilities (if any are discovered)
• Limited documentation and community support

Always use the latest stable version to get the best experience and access to all features.

These are the two main commands in mkarchi:

Yes! mkarchi automatically ignores common clutter like node_modules, .git, and __pycache__.

You can customize ignore patterns by creating a .mkarchiignore file in your project root. The syntax is identical to .gitignore:

For more details, check the Configuration section.

Yes, mkarchi is safe, but follow these best practices:

• Use version control: Always commit your work before running mkarchi
• Review structure files: Check what will be created before applying
• Start in a test directory: Test on a copy first if you're unsure
• Use .mkarchiignore: Protect sensitive files and directories

Note: mkarchi will overwrite existing files if they're defined in the structure file. Always backup important work!

We're here to help! Here are your options: