Getting Started

File Architect is a smart tool designed to streamline your project setup process. It allows you to quickly create complex folder structures, import files, and set up your development environment from a simple text outline.

Key Features

• Intuitive Structure Creation: Easily create complex nested folder and file structures using a simple, indentation-based syntax.
• File and folder imports: Import existing files and folders from your local machine directly into your project structure.
• File renaming: Rename imported files and folders specifically or globally as you create your structure.
• Customizable and reusable template system: Create templates and reuse them for your most frequent project structures.
• Shareable plain text format: Thise is all just text. Easy to share, copy-paste, generate, etc.

How It Works

You can create structures with a simple syntax like this:

            
project-X
src
components
Header.js
Footer.js
pages
Home.js
About.js
public
images
/Users/You/Images/dev_logo.png
/Users/You/Images/client-name_logo.png > company-logo.png
[path/to/project-docs]
README.md
            
        

project-X

src

components

Header.js

Footer.js

pages

Home.js

About.js

public

images

dev_logo.png

company-logo.png

README.md

project-docs

Quick syntax guide

Indentations

Tab indentation is used to determine the structure. Tabs are visually represented by the character | in the editor to help you see the structure, but you only need to use Tab when creating your own.

Folder Names

By default, if a line does not have an extension or a path separator, it will be treated as a folder name.

File Names

If a line has an extension, it will be treated as a file name and an empty file will be created. For files with extensions like .js, .vue, .css, .html, you'll be able to open and edit them normally. For binary data files like .png, .psd, .pdf, they will serve as placeholders.

File Import Path

If a string has a path separator, it will be treated as a file import path. File Architect will take the given path and copy the file to the current directory in your project structure.

Path with File Name Replacement

If a string has a path separator, followed by > and a file name, it will be treated as a file import path with a file name replacement. The file will be copied and then renamed with the specified file name.

Path with Folder Import

If a string has a path inside of brackets, it will be treated as a folder import path. The folder with all of its content will be copied into the current project structure.

Next Steps

Now that you're familiar with the basics of File Architect, explore our advanced features and integrations to further enhance your development workflow.

• Files and folders
• Templates