Creating a New Project¶

This guide will walk you through the steps to create a new project using the Zelos CLI.

Ask for help!

The Zelos CLI contains helper text for when you aren't sure how to use something. You can add --help/-h to any command to understand the usage better.

Prerequisites¶

Before you begin, ensure that you have Zelos installed on your system. If you haven't installed Zelos yet, refer to our Installation Guide.

Creating Your Project¶

To create a new project, follow these steps:

Open Your Terminal: Start by opening your terminal or command prompt. If you're using a virtual environment, make sure it's activated!
Run the Create Command: Use the zelos create project command followed by your project name.

zelos create project new-project

Optional Flags¶

Specify Destination¶

By default, the project is created in the current directory. To specify a different destination, use the -d or --destination flag:

zelos create project new-project --destination /path/to/destination

Replace /path/to/destination with your desired directory path.

Features¶

You can customize your project by specifying features. Use the -f or --feature flag followed by the feature name. Available features are:

serial: Includes support for serial communication.
can: Enables CAN network capabilities.
uds: Adds UDS protocol support.

For example, to include serial and CAN support:

zelos create project new-project -f serial -f can

Example¶

Here's an example command to create a new project named new-project with serial communication and CAN network capabilities in a specific directory:

zelos create project new-project -f serial -f can -d ~/zelos_projects

Project Structure¶

The CLI will create your project and apply the specified features. The folder structure will look something like this:

new-project              --> the name of your project
|-- tests                --> all your tests live here
|    |-- test_checker.py --> example test showcasing the checker
|    `-- ...
|-- confest.py           --> defines fixtures, plugins, helpers for your tests
|-- pytest.ini           --> configures pytest, includes a basic logging config
`-- README.md            --> contains some helper text about the project

Next Steps¶

Once your project is created, you'll see instructions on how to navigate to your project directory and run your first test. Follow these instructions to begin working on your project.