AYADN

App.net command-line client developed in Ruby.

• FEATURES
• TL;DR
• INSTALL
  • Step 1
  • Step 2
    • With Bundler
    • Without Bundler
  • Step 3 (optional)
  • Step 4
• HOW TO USE
  • Through the ruby interpreter
  • As an executable in your path
  • As a local executable
  • If you made the symlink
  • With an alias
• LIST OF COMMANDS
• TIPS
  • Username
  • Configuration
  • Skip specific posts
  • Backup some data
  • Post links
  • Reset pagination data
  • Custom posts count
  • Running multiple accounts
  • Pinboard
  • "me"
  • Shortcuts
  • Channels
  • Just for fun
• HELP
  • Console
  • Database
  • GCC
• CONTACT
• CREDITS
  • Beta-testers

FEATURES

• read/scroll your App.net stream

• write a post

• reply to a post

• read the conversation around a post

• star/unstar a post

• repost/unrepost a post

• quote a post

• send a private message

• read your private messages

• follow/unfollow a user

• ask if a user follows another one

• mute/unmute a user

• search posts for word(s)

• search posts with hashtag

• get informations on a post/user

• read/scroll posts from a user

• read/scroll posts mentioning a user

• read posts starred by a user

• see users who starred/reposted a post

• read/scroll other streams: "checkins", "global", "trending", "conversations"

• read a timeline of your interactions

• delete a post/message

• save/load a post locally

• backup/display your lists of followings, followers, muted users...

• create links with Markdown in your text

• skip posts from specific client (like IFTTT, PourOver, etc)

• skip posts containing specific #hashtag

• skip posts containing specific @username

• list, download, delete files from your ADN account

• change file attribute: public/private

• upload files to your ADN account (no Windows support)

• list your subscribed channels

• post to your subscribed channels

• save a post link to your Pinboard account

• post the current iTunes song with #nowplaying hashtag (OS X only)

• and more!

There's also a landing page and, of course, the blog.

TL;DR

git clone https://github.com/ericdke/ayadn.git
cd ayadn
bundle install
./ayadn.rb authorize
./ayadn.rb write 'Posting to App.net with Ruby!'

INSTALL

Mac OS X, Linux = it just works.

Ayadn is also compatible with Windows (install Ruby with Rubygems at http://rubyinstaller.org).

Step 1

Clone the project, or download the ZIP (button in the sidebar).

git clone https://github.com/ericdke/ayadn.git

Step 2

With Bundler

Mac OS X, Linux: if you already have bundler, you should just enter the ayadn folder and run bundle install.

Example if you cloned Ayadn in your downloads folder:

cd ~/Downloads/ayadn
bundle install

Installation done, you can jump to Step 3.

Without Bundler

If you're not using Bundler, you have to install some dependencies manually:

gem install json pinboard

Windows: you have one more gem to install:

gem install win32console -v 1.3.2

You only have to install the Gems once, it's not necessary to do it each time you update Ayadn.

Windows: jump to Step 4

Step 3 (optional)

While you can use the app with the ruby interpreter -see How to use-, it's recommended to make the app executable:

chmod +x ayadn.rb

Step 4

You have to authorize Ayadn to use your App.net credentials.

Just run Ayadn to start the process!

HOW TO USE

ayadn + optional action + optional target(s) + optional value(s)

If you don't provide any option to Ayadn, your personnalized stream is displayed.

If you provide the write command without text, you will enter the compose message feature. (recommended)

By default, Ayadn displays only the new posts in the stream since your last visit.

Through the ruby interpreter

If you've not made the app executable, use it through Ruby:

ruby ayadn.rb
ruby ayadn.rb write

As an executable in your path

If the app is executable and in your $PATH, just launch it:

ayadn.rb
ayadn.rb write 

As a local executable

If the app is executable but not in your $PATH, launch it locally:

./ayadn.rb
./ayadn.rb write

If you made the symlink

ayadn
ayadn write 

With an alias

The geekiest option is to make an alias in your .bashrc:

alias a="your/path/to/ayadn.rb"
source ~/.bashrc

Then it's easier to use, and very fast with the app's shortcuts:

a 
a w
a pm @ericd

Enjoy!

LIST OF COMMANDS

Only the first lines include the [PRESS ENTER KEY] indication and a description for obvious readability reasons.

ayadn [PRESS ENTER KEY] *to display the unified stream*
ayadn scroll [PRESS ENTER KEY] *to scroll the unified stream*
ayadn write [PRESS ENTER KEY] *to write your post*
ayadn write '@ericd Good morning Eric!' [PRESS ENTER KEY] *(prefer the previous method, safer)*
ayadn reply 18527205 [PRESS ENTER KEY] *to reply, then write your post*
ayadn pm @ericd [PRESS ENTER KEY] *to send a private message to @ericd*
ayadn global
ayadn scroll global
ayadn checkins
ayadn scroll checkins
ayadn trending
ayadn scroll trending
ayadn photos
ayadn scroll photos
ayadn conversations
ayadn scroll conversations
ayadn mentions @ericd
ayadn scroll mentions @ericd
ayadn posts @ericd
ayadn scroll posts @ericd
ayadn starred @ericd
ayadn starred 18527205
ayadn reposted 18527205
ayadn infos @ericd
ayadn infos 18527205
ayadn convo 15726105
ayadn tag nowplaying
ayadn follow @ericd
ayadn unfollow @ericd
ayadn mute @ayaio
ayadn unmute @ayaio
ayadn block @spammer
ayadn unblock @spammer
ayadn nowplaying
ayadn interactions
ayadn list files
ayadn list files all
ayadn download 286458
ayadn download 286458,286797
ayadn upload /path/to/kitten.jpg
ayadn private 286458
ayadn public 286458
ayadn delete-file 286458
ayadn search ruby
ayadn search ruby,json
ayadn channels
ayadn send 12345
ayadn messages 12345
ayadn messages 12345 all
ayadn star 18527205
ayadn unstar 18527205
ayadn repost 18527205
ayadn unrepost 18527205
ayadn quote 18527205
ayadn delete 12345678
ayadn delete-message 12345 23456789
ayadn list muted
ayadn list followings @ericd
ayadn list followers @ericd
ayadn backup muted
ayadn backup followings @ericd
ayadn backup followers @ericd
ayadn save 18527205
ayadn load 18527205
ayadn skip-source add IFTTT
ayadn skip-source remove IFTTT
ayadn skip-source show
ayadn skip-tag add sports
ayadn skip-tag remove sports
ayadn skip-tag show
ayadn skip-mention add username
ayadn skip-mention remove username
ayadn skip-mention show
ayadn pin 16864003 ruby,json
ayadn alias-channel 12345 channel_name
ayadn messages channel_name
ayadn list alias
ayadn unified 10
ayadn global 10
ayadn checkins 10
ayadn photos 10
ayadn trending 10
ayadn conversations 10
ayadn mentions @ericd 10
ayadn posts @ericd 10
ayadn starred @ericd 10
ayadn does @ericd follow @ayadn
ayadn reset pagination
ayadn list options
ayadn help
ayadn commands
ayadn webhelp
ayadn random

TIPS

Username

One thing I really recommend is to fill in your username in the config.yml file (without the "@").

Ayadn will then be able to perform a lot better and faster (less API calls, more colors, etc).

Configuration

Unless you're planning on using multiple accounts, you should then install the configuration file in the permanent Ayadn folder:

ayadn install config

Now you may safely edit your preferences in %USERDIR%/ayadn/data/config.yml without losing anything when updating Ayadn.

Skip specific posts

You can make posts containing a specific hashtag, like "#sports", or from a specific client, like "IFTTT" disappear from your timeline.

It works with users too: although App.net has the mute feature, it doesn't prevent the muted user to appear in reposts or to see posts mentioning him/her. This command allows you to do it.

ayadn skip-xxx add/remove target to add/remove from the 'skipped' list.

• Skip posts from specific client:

ayadn skip-source add IFTTT

• Skip posts with specific hashtag:

ayadn skip-tag add sports

• Skip posts with mentioning specific user:

ayadn skip-mention add username

Change of mind?

ayadn skip-source remove IFTTT ayadn skip-tag remove sports ayadn skip-mention remove username

There's basically no verification with this feature, so be careful to not add misspelled or non-existent info.

Backup some data

ayadn backup followings @ericd
ayadn backup followers @ericd
ayadn backup muted

A JSON file containing the username and real name of your followings/followers/muted will be saved in %USERDIR%/ayadn/data/lists.

The muted option only works for yourself (this is a normal limitation from the API).

Post links

• Write/paste a simple link:

ayadn write 'Subscribe to the #Ayadn broadcast! https://app.net/c/2zqf'

• Write/paste a markdown link to embed the link:

ayadn write '[Subscribe](https://app.net/c/2zqf) to the #Ayadn broadcast!'

Reset pagination data

If Ayadn shows you "No recent posts" but you still want to see the stream again, you have to reset the pagination data first.

ayadn reset
ayadn reset pagination unified
ayadn reset pagination mentions @ericd
ayadn reset pagination posts @ericd
(etc)

Without arguments: resets all your pagination data.

Note: Ayadn doesn't use Stream Markers (stream syncing), and it's not a bug but a feature :p This is because Ayadn is meant as an independent tool that shouldn't interfere with other ADN clients.

Custom posts count

You can specify the number of posts retrieved with most streams:

ayadn unified 10
ayadn global 10
ayadn checkins 10
ayadn photos 10
ayadn trending 10
ayadn conversations 10
ayadn mentions @ericd 10
ayadn posts @ericd 10
ayadn starred @ericd 10

Running multiple accounts

• main idea: one Ayadn folder per account
• change the name of the ayadn folder to @yourusername
• replace "me" in config.yml by your username (without "@")
• do ayadn authorize to force a new process (you may have to log off your browser (or delete cookies) first if you want to change accounts)
• don't ever run "ayadn install config" or Ayadn will ignore your multiple settings

Pinboard

Export a post link + text + tags to Pinboard:

ayadn pin 15723266 tag1,tag2

"me"

With some features you can replace @username by me if you want to check yourself:

ayadn mentions me
ayadn scroll mentions me
ayadn posts me
ayadn starred me
ayadn infos me
ayadn list followings me
(etc)

Shortcuts

Some commands have shortcuts:

• write: w
• reply: r
• quote: q
• mentions: m
• posts: p
• channels: ch
• messages: msg
• infos: i
• convo: c
• tag: t
• search: s
• nowplaying: np
• help: h

Examples:

ayadn w
ayadn r 12345678
ayadn m @ericd
ayadn t ruby
ayadn np

Other commands don't have a shortcut, reducing the risk of accidental manipulation.

Channels

You may display your channels with ayadn channels and read their messages with ayadn messages 12345 with 12345 being the channel ID.

To ease the process, you can create aliases for channel IDs:

ayadn alias-channel 12345 mychannel

then read its messages with ayadn messages mychannel.

List your existing aliases with ayadn list alias.

Aliases are cumulable. If something goes awfully wrong, just trash the file: %USERNAME%/ayadn/data/username/db/channels_alias.db

Just for fun

ayadn random

HELP

Console

Be aware of the way the console/terminal treats what you type.

When posting with "double quotes", any special character will be interpreted!

So "echo !" becomes "echo last command". You may not want to do that...

So you have to post with 'simple quotes', this way the console don't mess with your content.

The thing is, how do you then post a text containing one ore more exclamation marks AND/OR one or more simple quotes?

The answer is to post with "double quotes" but use \, the antislash character, before any exclamation mark:

ayadn.rb write "Here's an escaped exclamation mark \! and a normal simple quote in the same text"

My advice: to avoid any problems, post with the compose feature, that is to say without providing arguments:

ayadn.rb write

Database

Ayadn keeps a database of the ids of all the users it sees (it reduces the number of API calls and speeds up the app.)

If you think that this file is causing problems to Ayadn or if it's simply getting too big, just trash it.

The file is: %USERNAME%/ayadn/data/username/db/users.db

GCC

If you've got an error while installing or cloning regarding gcc not found, just type:

which gcc

It should give you the location of your gcc, typically /usr/bin/gcc. Then make a symlink:

sudo ln -s /usr/bin/gcc /usr/bin/gcc-4.2

On Mac OS X, you may have to answer yes if your computer asks you to download and install the "developer tools".

CONTACT

Contact me on ADN (@ericd) if you have questions, ideas, or... if you know Ruby and you want to help a newbie to code better. ;)

The handle for the app itself is @ayadn and will be used for support, bug report, etc.

Don't bother with @ayaio or @aya_tests, they are bots.

CREDITS

Beta-testers

• Windows: @ksniod

• Linux:

  • @martner_mala
  • @nguarracino

• OpenBSD: (soon)