Tyrs Quick Start

This is a short introduction to using Tyrs, and doesn’t go into too much detail about configuration or installation. It is intended to get you up and running Tyrs quickly.

For more information, you could read these documents:

First authentication

Both Twitter and Identi.ca use OAuth for authentication. The first step, with both services, is to authenticate.

When you start the application, and it doesn’t find a profile file, it will print:

Message when no profile is detected

There is no profile detected.

The default location for a config file is $XDG_CONFIG_HOME/tyrs/tyrs.cfg which would usually be something like: /home/nicolas/.config/tyrs/tyrs.cfg

If you want to setup a new account, you are required to complete some basic
steps.
If you want to skip this, just press return or Ctrl-c.

Which service do you want to use?

1. Twitter
2. Identi.ca

Requesting temp token from Twitter

Please visit this Twitter page and retrieve the pincode to be used
in the next step for obtaining an Authentication Token:

https://api.twitter.com/oauth/authorize?oauth_token=OxFDW4zW3YeiueuizjazAa4VSdeuieuiMO5b8GpS8EoDKRM

Pincode?

You only need to go to the link show above, and copy the code that the Twitter provides. And that’s it, you are now able to access Twitter from your console.

For Identi.ca, one more question will be asked: Which root url do you want? (leave blank for default value, https://identi.ca/api)

If you are using identi.ca, leave the default value, and just press return. You only need to change this if you have your own StatusNet server running.

If you have several accounts, you can specify which one to use by starting the application with -a argument.

tyrs -a foo

Usage

Tyrs is mostly used with the keyboard, and comes with default key shortcuts (you may customize these). Below is a list of the most common ones. You may check the full reference guide for more details.

Navigation

j: Move down
k: Move up
arrow keys also allow you to navigate between timelines or tweets

Functions

t: Open a box to edit a tweet
r: Retweet the current tweet
T: View thread reply (message will have an envelope next to it)
f: F: Follow someone (f, follow the current, F be prompted for who you want follow)
l: L: Unfollow (leave) someone
q: Quit
c: Clear the timeline
u: Update the timeline

Tweet editing

ESC: Abort the edit
ENTER: Validation/Send
DEL: delete last character

Configuration

You can use a configuration file, although there is no need to have one for Tyrs to work, where you can customize your keybindings, color and basic behavior.

The default location for a configuration file is $XDG_CONFIG_HOME/tyrs/tyrs.cfg which would usually be something like: /home/nicolas/.config/tyrs/tyrs.cfg

To learn how the configuration works, check the configuration part of the reference guide.

An easy way to start with the configuration file, it’s to generate one from the command line interface. It will generate a file with the required parameters (you can then edit this file to suit your requirements).

tyrs -g ~/.config/tyrs/tyrs.cfg

You may have more than one configuration file. To use an account-specific .cfg file, start with a -c argument. (or --config)

Related Sites

Check the development on Github
Found a bug ? or want to propose an idea, check the BugTracker
Ask any questions, or just follow latest news on the mailing list.