Skip to content

CLI Setup

SenfCLI allows you to sync .env files from different backends and keeps track of unsynced changes.

Setup

Installation

  1. Visit Releases and download the files for your system.
  2. Extract the archive and follow the instructions for your target OS

Windows:

  • Press Win+R and enter %LOCALAPPDATA%\Programs
  • Create a new directory called Senf
  • Paste the .exe from the extracted archive into this folder
  • Open a terminal and execute the following Powershell command: 
    $dir="$env:LOCALAPPDATA\Programs\Senf"; $p=[Environment]::GetEnvironmentVariable("PATH","User"); if(-not ($p -split ';' | Where-Object { $_ -eq $dir })){ [Environment]::SetEnvironmentVariable("PATH", "$p;$dir", "User") }

Linux:

  • Copy the executable into /usr/local/bin
  • If you have any active terminal sessions, restart them or run source ~/.bashrc

MacOS: Currently not supported.

Profile Configuration

A Senf user profile is a reference to which SSH key should be used for which API backend.

Prerequisites

A new user can only be created with direct access to the backend while user profiles are created only locally on your machine. For more information about how to add a user, visit the Backend Guide

For authentication, Senf uses SSH keys. They are typically located at ~/.ssh or you can create a new key by running 

ssh-keygen -t ed25519 -f ~/.ssh/senf

If you are on Windows, you may need to enable the OpenSSH Client first.

New Userprofile

New Machine

When you want to sync files between multiple machines, you need to allow the machine through another SSH key onto the same backend user