Quick start

This page takes you from nothing to a project saved on your computer and shared on Zaryn. You don't need to know git or any other version control tool. Each step says what the command does and why. > **What is version control?** It is a tool that remembers every saved version of your project. You can see what changed, go back to an older version, try ideas on the side without breaking anything, and work with other people on the same files. zev is the version control tool, and Zaryn is the website where your projects live online. ## 1. Install zev On **Linux or macOS**, open a terminal and run: ```bash curl -fsSL https://zaryn.xyz/install.sh | sh ``` On **Windows**, open PowerShell and run: ```powershell irm https://zaryn.xyz/install.ps1 | iex ``` Check that it worked: ```bash zev --version ``` You should see something like `zev 0.3.0 (x86_64-linux)`. More options, such as apt, dnf or pacman, are on the [Installation](/docs/en/installation) page. ## 2. Make a project Go to the folder of your project (or make a new one) and turn it into a zev repository: ```bash mkdir my-project cd my-project zev init ``` `zev init` creates a hidden `.zev` folder. That is where zev keeps the history. Your own files stay exactly as they are. Tell zev who you are. Your name goes on every commit you make: ```bash zev config set user.name "Your Name" zev config set user.email "you@example.com" ``` ## 3. Save your first version Create a file, or use the files you already have: ```bash echo "# My project" > README.md ``` Saving a version takes two steps: ```bash zev add . zev commit -m "First version" ``` - `zev add .` picks **what** goes into the next save. The `.` means "everything in this folder". This is called *staging*. - `zev commit -m "..."` **saves** what you staged, with a short message about what you did. Each save is called a *commit*. Why two steps? Because you often change many files but want to save only some of them together. `zev add` lets you choose. ## 4. Change something and see the difference Edit `README.md`, then ask zev what changed: ```bash zev status ``` `zev status` lists the files you changed, the files you staged, and new files zev doesn't track yet. Each section of its output also says which command to run next. To see the exact lines that changed: ```bash zev diff ``` Lines starting with `+` were added and lines starting with `-` were removed. When you're happy, save again: ```bash zev add README.md zev commit -m "Describe the project" ``` See all your saves so far: ```bash zev log --oneline ``` ## 5. Share it on Zaryn Create your account from the terminal. zev emails you a 6-digit code to confirm your address: ```bash zev login zaryn.xyz --register your-username --email you@example.com ``` Type the code when zev asks for it. You sign in once per computer; every project on it uses the same sign-in. Already made an account on the [zaryn.xyz](https://zaryn.xyz) website? Then sign in with your browser instead: ```bash zev login zaryn.xyz --device ``` zev prints a link and a short code. Open the link, check the code matches, and approve. Now create the project on Zaryn and send your commits there: ```bash zev new zev push ``` `zev new` asks for a name, the kind of project, public or private, and a license. It creates the repository on Zaryn and remembers it as `origin`, the default place to push to. `zev push` sends your commits. Open `https://zaryn.xyz/your-username/the-name` to see them. ## The everyday loop Most days, you only need these five commands: ```bash zev status # what changed? zev diff # how exactly? zev add . # choose what to save zev commit -m "what you did" # save it zev push # share it ``` When you work with others, run `zev pull` first to get their latest changes. ## Where to go next - [Your first repository, step by step](/docs/en/first-repository): the same ideas in more depth, including undoing mistakes. - [How do I…?](/docs/en/how-do-i): short answers for common tasks ("undo a change", "delete a file", "work on a branch"). - [All commands](/docs/en/commands): every zev command, with the everyday ones first. - Stuck? See [When something goes wrong](/docs/en/troubleshooting), or press `/` on any docs page to search.