Currently the template help has the following interface:
```
usage: clan [-h] [SUBCOMMAND]
The clan cli tool
positional arguments:
{show,backups,b,flakes,f,templates,flash,ssh,secrets,facts,vars,va,machines,m,vms,select,se,state,st}
show Show meta information about the clan
backups (b) Manage backups of clan machines
flakes (f) Create a clan flake inside the current directory
templates Subcommands to interact with templates
flash Flashes your machine to an USB drive
ssh Ssh to a remote machine
secrets Manage secrets
facts Manage facts
vars (va) Manage vars
machines (m) Manage machines and their configuration
vms Manage virtual machines
select (se) Select nixos values from the flake
state (st) Query state information about machines
options:
-h, --help show this help message and exit
Online reference for the clan cli tool: ]8;;https://docs.clan.lol/reference/cli\https://docs.clan.lol/reference/cli]8;;\
For more detailed information, visit: ]8;;https://docs.clan.lol\https://docs.clan.lol]8;;\
```
Clan core repository
Welcome to the Clan core repository, the heart of the clan.lol project! This monorepo is the foundation of Clan, a revolutionary open-source project aimed at restoring fun, freedom, and functionality to computing. Here, you'll find all the essential packages, NixOS modules, CLI tools, and tests needed to contribute to and work with the Clan project. Clan leverages the Nix system to ensure reliability, security, and seamless management of digital environments, putting the power back into the hands of users.
Why Clan?
Our mission is simple: to democratize computing by providing tools that empower users, foster innovation, and challenge outdated paradigms. Clan represents our contribution to a future where technology serves humanity, not the other way around. By participating in Clan, you're joining a movement dedicated to creating a secure, user-empowered digital future.
Features of Clan
- Full-Stack System Deployment: Utilize Clan’s toolkit alongside Nix's reliability to build and manage systems effortlessly.
- Overlay Networks: Secure, private communication channels between devices.
- Virtual Machine Integration: Seamless operation of VM applications within the main operating system.
- Robust Backup Management: Long-term, self-hosted data preservation.
- Intuitive Secret Management: Simplified encryption and password management processes.
Getting started with Clan
If you're new to Clan and eager to dive in, start with our quickstart guide and explore the core functionalities that Clan offers:
- Quickstart Guide: Check out getting started to get up and running with Clan in no time.
Managing secrets
In the Clan ecosystem, security is paramount. Learn how to handle secrets effectively:
- Secrets Management: Securely manage secrets by consulting secrets.
Contributing to Clan
The Clan project thrives on community contributions. We welcome everyone to contribute and collaborate:
- Contribution Guidelines: Make a meaningful impact by following the steps in contributing.
Join the revolution
Clan is more than a tool; it's a movement towards a better digital future. By contributing to the Clan project, you're part of changing technology for the better, together.
Community and support
Connect with us and the Clan community for support and discussion:
- Matrix channel for live discussions.
- IRC bridge on hackint#clan for real-time chat support.