87 lines
2.4 KiB
Text
87 lines
2.4 KiB
Text
// SPDX-FileCopyrightText: 2024 Dan Anglin <d.n.i.anglin@gmail.com>
|
|
//
|
|
// SPDX-License-Identifier: CC-BY-4.0
|
|
|
|
= Enbas
|
|
:toc: left
|
|
:toclevels: 3
|
|
:toc-title: Table of Contents
|
|
|
|
== Overview
|
|
|
|
Enbas is a https://docs.gotosocial.org/en/latest/[GoToSocial] client for your terminal written
|
|
in https://go.dev[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 link:LICENSES/GPL-3.0-or-later.txt[here].
|
|
|
|
=== Repository mirrors
|
|
|
|
Enbas is primarily developed in Code Flow https://codeflow.dananglin.me.uk/apollo/enbas[here] with the `main` branch pushed to
|
|
https://codeberg.org/dananglin/enbas[Codeberg] and https://github.com/dananglin/enbas[GitHub]
|
|
|
|
== Installation
|
|
|
|
(Moved)
|
|
|
|
== Configuration
|
|
|
|
Enbas uses Go's https://pkg.go.dev/os#UserConfigDir[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
|
|
+
|
|
[source,console]
|
|
----
|
|
enbas show --type account --my-account
|
|
----
|
|
|
|
* View a local or remote account
|
|
+
|
|
[source,console]
|
|
----
|
|
enbas show --type account --account teddy@gotosocial-01.social.example
|
|
----
|
|
|
|
* View your home timeline
|
|
+
|
|
[source,console]
|
|
----
|
|
enbas show --type timeline
|
|
----
|
|
|
|
* View the details of a status
|
|
+
|
|
[source,console]
|
|
----
|
|
enbas show --type status --status-id 01HQE43KT5YEDN4RGMT7BC63PF
|
|
----
|
|
|
|
== Inspirations
|
|
|
|
This project was inspired by the following projects:
|
|
|
|
* **madonctl:** https://github.com/McKael/madonctl[A Mastodon CLI client written in Go.]
|
|
* **toot:** https://pypi.org/project/toot/[A Mastodon CLI and TUI written in Python.]
|
|
* **tut:** https://github.com/RasmusLindroth/tut[A Mastodon TUI written in Go.]
|