enbas/README.asciidoc

Enbas

Table of Contents

• Overview
  • Repository mirrors
• Installation
• Configuration
• Usage
  • Log into your GoToSocial account
  • Common actions
• Inspirations

Overview

Enbas is a GoToSocial client for your terminal written in Go.

The project is in its early stages of development so expect bugs, breaking changes and limited functionality at this time It is not recommended for use this with your production GoToSocial servers.

This project is licensed under the GNU General Public License V3 or later which you can view here.

Repository mirrors

Enbas is primarily developed in Code Flow here with the main branch pushed to Codeberg and GitHub

Installation

(Moved)

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

Log into your GoToSocial account

(Moved)

Common actions

• View your account information

  enbas show --type account --my-account

• View a local or remote account

  enbas show --type account --account teddy@gotosocial-01.social.example

• View your home timeline

  enbas show --type timeline

• View the details of a status

  enbas show --type status --status-id 01HQE43KT5YEDN4RGMT7BC63PF

Inspirations

This project was inspired by the following projects:

• madonctl: A Mastodon CLI client written in Go.

• toot: A Mastodon CLI and TUI written in Python.

• tut: A Mastodon TUI written in Go.