2024-04-05 16:03:14 +00:00
# **Quick Start Guide to Initializing a New Clan Project**
2023-08-30 11:51:08 +00:00
2024-04-05 16:03:14 +00:00
This guide will lead you through initiating a new Clan project
2023-08-30 11:51:08 +00:00
2024-04-05 16:03:14 +00:00
## **Overview**
2023-08-30 11:51:08 +00:00
2024-04-05 16:03:14 +00:00
Dive into our structured guide tailored to meet your needs:
2023-08-30 11:51:08 +00:00
2024-04-05 16:03:14 +00:00
- [**Starting with a New Clan Project** ](#starting-with-a-new-clan-project ): Kickstart your journey with Clan by setting up a new project from the ground up.
- [**Migrating Existing Flake Configuration** ](migrate.md#migrating-existing-nixos-configuration-flake ): Transition your existing flake-based Nix configuration to harness the power of Clan Core.
- [**Integrating Clan using Flake-Parts** ](./migrate.md#integrating-clan-with-flakes-using-flake-parts ): Enhance your Clan experience by integrating it with Flake-Parts.
2023-09-21 12:40:38 +00:00
2023-08-30 11:51:08 +00:00
---
2024-04-05 16:03:14 +00:00
## **Starting with a New Clan Project**
2023-08-30 13:25:20 +00:00
2024-04-05 16:03:14 +00:00
Embark on your Clan adventure with these initial steps:
2023-08-30 13:25:20 +00:00
2024-04-05 16:03:14 +00:00
### **Step 1: Add Clan CLI to Your Shell**
Incorporate the Clan CLI into your development workflow with this simple command:
```shell
nix shell git+https://git.clan.lol/clan/clan-core
2024-04-04 13:05:08 +00:00
```
2024-04-05 16:03:14 +00:00
### **Step 2: Initialize Your Project**
Set the foundation of your Clan project by initializing it as follows:
```shell
clan flakes create my-clan
```
This command crafts the essential `flake.nix` and `.clan-flake` files for your project.
2024-04-04 13:05:08 +00:00
2024-04-05 16:03:14 +00:00
### **Step 3: Verify the Project Structure**
Ensure the creation of your project files with a quick directory listing:
```shell
cd my-clan & & ls -la
2024-04-04 13:05:08 +00:00
```
2024-04-05 16:03:14 +00:00
Look for `.clan-flake` , `flake.lock` , and `flake.nix` among your files to confirm successful setup.
2024-04-04 13:05:08 +00:00
2024-04-05 16:03:14 +00:00
### **Understanding `.clan-flake`**
The `.clan-flake` file, while optional, is instrumental in helping the Clan CLI identify your project's root directory, easing project management.
2024-04-04 13:05:08 +00:00
2024-04-05 16:03:14 +00:00
### **Next Steps**
Ready to expand? Explore how to add new machines to your project with the helpful documentation [here ](./machines.md ).
2024-04-04 13:05:08 +00:00
2024-04-05 16:03:14 +00:00
---