aigne create

Ready to start your AIGNE journey? The aigne create command is your starting point. It sets up a new AIGNE project, creating all the necessary files and configurations so you can begin building your AI Agent right away.

This command runs an interactive setup process, guiding you through naming your project and selecting a template. Let's walk through how it works.

Usage#

The command is straightforward. You can either create a project in a new directory or within the current one.

Arguments#

Argument	Description
[path]	Optional. The path where the project directory will be created. If you provide a name like my-project, a new folder will be created. If you use . or omit it, the command will try to create the project in the current directory.

The Creation Process#

Running aigne create kicks off a simple, interactive process. Here is what you can expect:

1. Project Name: If you don't specify a path, you'll be asked to provide a name for your project.
2. Overwrite Check: If the target directory already contains files, the CLI will ask for your permission to remove existing contents before proceeding. This is a safeguard to prevent accidental data loss.
3. Template Selection: You'll be prompted to choose a project template. Currently, a default template is provided to get you started quickly.

What You Get#

Once the command finishes, you'll have a new project directory with a clean structure, ready for you to customize. The default template includes everything you need for a basic chat Agent with a JavaScript execution tool.

To learn about the specific files and their roles, check out the detailed guide on the Default Project Template.

Next Steps#

Your AIGNE project is now ready. The next logical step is to run your Agent and start interacting with it.

Navigate to your new project directory and use the aigne run command:

For a full guide on running your Agent and all available options, head over to the aigne run documentation.