apollo/enbas
1
0
Fork 0
Code Issues 4 Pull requests Projects Activity Actions
enbas/README.asciidoc
Dan Anglin 626c066537
add config section
2024-02-25 15:40:54 +00:00

3.5 KiB
Raw Blame History

Enbas

Table of Contents

Overview

Enbas is a GoToSocial client for your terminal written in Go. The project is currently a work in progress so breaking changes will be made and bugs may appear here and there during its early development. Enbas has limited functionality at the moment and it is not recommended for use with your production GoToSocial servers.

This project is licensed under GPLv3.

Installation

Download

Pre-built binaries will be available on the release page on both Codeberg and GitHub when the first release is made.

Build from source

Requirements

Go

A minimum version of Go 1.22.0 is required for installing spruce. Please go here to download the latest version.

Mage (Optional)

The project includes mage targets for building and installing the binary. The main advantage of using mage is that the binary’s build information is baked into the binary during compilation. You can visit the Mage website for instructions on how to install Mage.

Install with mage

You can install Enbas with Mage using the following commands:

git clone https://github.com/dananglin/enbas.git
cd enbas/internal/build/
mage install

By default Mage will attempt to install Enbas to /usr/local/bin/enbas which will most likely fail as you won’t the permission to write to /usr/local/bin/. You will need to either run sudo mage install, or you can (preferably) change the install prefix to a directory that you have permission to write to using the ENBAS_INSTALL_PREFIX environment variable. For example:

ENBAS_INSTALL_PREFIX=${HOME}/.local mage install

This will install Enbas to ~/.local/bin/enbas.

Install with go

If your GOBIN directory is included in your PATH then you can install Enbas with Go.

git clone https://github.com/dananglin/enbas.git
cd enbas
go install ./cmd/enbas

Configuration

Enbas uses Go’s os.UserConfigDir() function to determine the location of your configuration directory.

If you’ve set the XDG_CONFIG_HOME environment variable, the configuration files will be stored in the $XDG_CONFIG_HOME/enbas directory.

If this is not set:

  • on Linux the configuration directory will be set to $HOME/.config/enbas.

  • on Darwin (MacOS) the configuration directory will be set to $HOME/Library/Application Support/enbas.

  • on Windows the configuration directory will be set within the %AppData% directory.

If (for whatever reason) any of the above cannot be determined, the configuration directory will be set to the current working directory.

Usage

Check the build information

Check out the help documentation

Log into your GoToSocial account

View your account information

View a remote account

View your timeline

View a status

Inspirations

This project was inspired from the following projects: