Skip to main content

Getting Started

The easiest way to get started with AIM is to run the following command:

bunx aimx init

This will ask a name for your project and create a new AIM project in the current directory.

Then install the dependencies:

bun i

Once the project is initialized, you can start writing your Markdown AIM documents in the ./files directory.

You can run the following command to execute your AIM documents:

bunx aimx run ./files

This will prompt you with the existing files in the ./files directory and ask you to select one to execute.

You can also run individual files by running:

bunx aimx run ./files/example.md

And that's it! You can now start writing your AIM documents and execute them.

Now you can set your .env file and add things to aim.config.ts to customize your project.