{"id":21607709,"url":"https://github.com/eliah-w/birdknife","last_synced_at":"2025-07-17T06:32:06.312Z","repository":{"id":68319077,"uuid":"53044657","full_name":"vanita5/birdknife","owner":"vanita5","description":"birdknife is a Twitter CLI based on Vorpal inspired by TTYtter.","archived":false,"fork":false,"pushed_at":"2017-12-28T10:10:07.000Z","size":1330,"stargazers_count":31,"open_issues_count":17,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-24T10:09:56.489Z","etag":null,"topics":["babel","cli","es6","node","ttytter","tweets","twitter","twitter-cli","vorpal"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vanita5.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2016-03-03T11:17:53.000Z","updated_at":"2022-04-12T15:01:58.000Z","dependencies_parsed_at":"2023-03-07T06:31:14.963Z","dependency_job_id":null,"html_url":"https://github.com/vanita5/birdknife","commit_stats":{"total_commits":273,"total_committers":3,"mean_commits":91.0,"dds":0.1428571428571429,"last_synced_commit":"2361e860b47eda5fe8e253b1d2ba46cc1cba8eb6"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanita5%2Fbirdknife","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanita5%2Fbirdknife/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanita5%2Fbirdknife/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vanita5%2Fbirdknife/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vanita5","download_url":"https://codeload.github.com/vanita5/birdknife/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226148890,"owners_count":17581052,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["babel","cli","es6","node","ttytter","tweets","twitter","twitter-cli","vorpal"],"created_at":"2024-11-24T20:33:05.187Z","updated_at":"2025-07-17T06:32:00.865Z","avatar_url":"https://github.com/vanita5.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"birdknife2.png\"/\u003e\n\u003c/p\u003e\n\n\u003e Twitter CLI\n\n[![Build Status](https://travis-ci.org/vanita5/birdknife.svg)](https://travis-ci.org/vanita5/birdknife) [![NPM Downloads](https://img.shields.io/npm/dt/birdknife.svg)](https://www.npmjs.com/package/birdknife) [![NPM Version](https://img.shields.io/npm/v/birdknife.svg)](https://www.npmjs.com/package/birdknife) [![Dependency Status](https://www.versioneye.com/user/projects/56d83d23d716950040a0f014/badge.svg?style=flat)](https://www.versioneye.com/user/projects/56d83d23d716950040a0f014) [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)\n\nbirdknife is a Twitter CLI based on [Vorpal](https://github.com/dthree/vorpal) inspired by [TTYtter](http://www.floodgap.com/software/ttytter/).\nTTYtter hasn't been updated for some time now and doesn't support new features introduced by Twitter. This project aims to be a completely\nfunctional Twitter client for your CLI.\n\n## Features\n\n* Full featured Twitter CLI\n* Cross platform\n* Read your timeline and interact with tweets\n    * Reply, retweet, like (fav), quote,...\n* Interact with users\n    * Follow, block, mute\n* Update your status with media and location\n* Search on Twitter\n* Hashtag and @screen_name autocompletion\n* Notifications (Cross platform)\n\n#### In the future\n\n* Work with lists\n    * Follow, view, create, add/remove users,...\n* Manage multiple accounts\n* Open/View media and urls (browser or image viewer)\n\n## Installation\n\nInstall `birdknife` globally via npm:\n\n```bash\n$ npm install birdknife -g\n```\n\n## Configuration\n\nAfter initially calling birdknife, you should find a configuration file in your home directory.\n\n**GNU/Linux, Mac OS X,...**\n`~/.birdknife.json`\n\n**Windows**\n`C:\\Users\\user\\.birdknife.json`\n\nExample:\n```json\n{\n  \"version\": 5,\n  \"auth\": {\n    \"consumer_key\": \"XXXXXXXXXXXXXXXXXXXXXX\",\n    \"consumer_secret\": \"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\",\n    \"access_token\": \"00000000-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n    \"access_token_secret\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\"\n  },\n  \"preferences\": {\n    \"debug\": false,\n    \"notifications\": true,\n    \"location\": false,\n    \"tweet_protection\": false,\n    \"timestamp\": 5\n  }\n}\n```\n\n**Only edit values under the `preferences` section!**\n\n### Preferences\n\n\u003ctable\u003e\n    \u003ctr\u003e\n        \u003cth\u003ePreference\u003c/th\u003e\n        \u003cth\u003eDescription\u003c/th\u003e\n        \u003cth\u003eValues\u003c/th\u003e\n        \u003cth\u003eDefault\u003c/th\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003ccode\u003edebug\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003eEnable/Disable debug output for streaming events like limits, disconnects and reconnects.\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003efalse\u003c/code\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003ccode\u003enotifications\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003eEnable/Disable notifications. \u003ci\u003ebirdknife\u003c/i\u003e can display notifications for \u003ci\u003ementions, likes, retweets, followings,...\u003c/i\u003e\u003cbr/\u003e\n        This is a cross platform feature running on \u003cb\u003eGNU/Linux\u003c/b\u003e (\u003ccode\u003enotify-osd\u003c/code\u003e or \u003ccode\u003elibnotify\u003c/code\u003e),\u003cbr/\u003e\n        \u003cb\u003eMac OS X\u003c/b\u003e (NotificationCenter, since 10.8) and \u003cb\u003eWindows 8\u003c/b\u003e (and newer).\u003cbr/\u003e\n        Alternatively it supports \u003cb\u003eGrowl\u003c/b\u003e in case nothing else works.\n        \u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003etrue\u003c/code\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003ccode\u003elocation\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003eEnable/Disable posting your location. The location can be detected automatically.\u003cbr/\u003eAlternatively you can provide coordinations.\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e\"auto\"\u003c/code\u003e (or \u003ccode\u003etrue\u003c/code\u003e),\u003cbr/\u003e\n        \u003ccode\u003e{ lat: 57.52936, lng:  -6.24176 }\u003c/code\u003e\n        \u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003efalse\u003c/code\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e\u003ccode\u003etweet_protection\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003eIf set to true this should prevent accidentally posting a status update. To post a status, enter \u003ccode\u003e/tweet\u003c/code\u003e first.\u003cbr/\u003e\n        This command provides a new prompt where you can enter your status update.\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003efalse\u003c/code\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n        \u003ctd\u003e\u003ccode\u003etimestamp\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003eSet the time interval in minutes where birdknife will print out timestamps.\u003cbr/\u003e\n        To disable timestamps, set \u003ccode\u003etimestamp\u003c/code\u003e to \u003ccode\u003e0\u003c/code\u003e.\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003e0\u003c/code\u003e-\u003ccode\u003e59\u003c/code\u003e\u003c/td\u003e\n        \u003ctd\u003e\u003ccode\u003e5\u003c/code\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n\u003c/table\u003e\n\n#### Edit preferences\n\n_Note: You can also directly edit the config file!_\n\n##### List preferences\n\n```\nbirdknife [---]\u003e /preferences\n|\n|   debug:          false\n|   notifications:  true\n|   location:       \"auto\"\n|\n```\n\n##### Set preference\n\n```\nbirdknife [---]\u003e /set notifications false\nnotifications is now set to false\n\nbirdknife [---]\u003e /set location { \"lat\": 57.52936, \"lng\": -6.24176 }\nlocation is now set to [object Object]\n\nbirdknife [---]\u003e /preferences\n|\n|   debug:          false\n|   notifications:  false\n|   location:       {\"lat\":57.52936,\"lng\":-6.24176}\n|\n```\n\n## Information\n\n##### Tweet prefix\n\nSome tweets have a prefix before the username. Those prefixes indicate characteristics of a tweet.\n\nExample: `b1\u003e \u003c*@username\u003e: What a beautiful day!`\n\n\u003ctable\u003e\n    \u003ctr\u003e\n        \u003cth\u003ePrefix\u003c/th\u003e\n        \u003cth\u003eDescription\u003c/th\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e*\u003c/td\u003e\n        \u003ctd\u003eIndicates that this tweet is a reply to another tweet. It is probably part of a conversation/thread.\u003cbr/\u003e\n        \u003cb\u003eHint:\u003c/b\u003e Run \u003ccode\u003e/thread \u003cid\u003e\u003c/code\u003e to view the thread.\u003c/td\u003e\n    \u003c/tr\u003e\n    \u003ctr\u003e\n        \u003ctd\u003e↑\u003c/td\u003e\n        \u003ctd\u003eThis tweet is either a reply to the tweet above (only in conversations) or has been quoted by the tweet above.\u003c/td\u003e\n    \u003c/tr\u003e\n\u003c/table\u003e\n\n## Usage\n\n##### Login (PIN authorization)\n\n```\nbirdknife [---]\u003e /login\n\nLogin and copy the PIN number: https://twitter.com/oauth/authorize?oauth_token=XXXX-XXXXXXXXXXXXXXXXXXXXXX\nPIN:\n```\n\nTo remove your account from birdknife: `/logout`\n\n##### Tweet\n\nThe easy way:\n```\nbirdknife [128]\u003e Hello World!\n```\n\n\nHow to post *multiline* tweets:\n```\nbirdknife [...]\u003e /tweet\n\nEnter /send to update your status.\nTweet [136]\u003e This\nTweet [133]\u003e is\nTweet [131]\u003e a\nTweet [121]\u003e multiline\nTweet [114]\u003e tweet!\nTweet [...]\u003e /send\n\na1\u003e \u003c@_vanita5\u003e: This\nis\na\nmultiline\ntweet!\n```\n\n\nHow to post tweets with media:\n```\nbirdknife [...]\u003e /tweet /home/vanita5/dog.png /home/vanita5/cat.png\n\nEnter /send to update your status.\nTweet [124]\u003e Look at my pets!\nTweet [123]\u003e /send\n-- Uploading file: /home/vanita5/dog.png\n-- Uploading file: /home/vanita5/cat.png\n\nab\u003e \u003c@_vanita5\u003e: Look at my pets! pic.twitter.com/xxxxxxxxx\n```\n*Note: This command has filesystem autocompletion!*\n\n##### View threads / conversations\n\n```\nbirdknife [---]\u003e /thread \u003cid\u003e\n```\n\n##### Reply to a tweet\n\n```\na1\u003e \u003c@twitter\u003e: #birdknife is kinda nice!\n\nbirdknife [124]\u003e /reply a1 FAAAKE!\n```\nAlias: ```/re```\n\n##### Quote a tweet\n\n```\na1\u003e \u003c@twitter\u003e: #birdknife is kinda nice!\n\nbirdknife [109]\u003e /quote a1 FAAAKE!\n\na2\u003e \u003c@_vanita5\u003e: FAAAKE! https://twitter.com/twitter/status/12345678901234\n\na3\u003e |   \u003c↑@twitter\u003e: #birdknife is kinda nice!\n```\n\n##### Retweet\n\n```\nbirdknife [---]\u003e /retweet \u003cid\u003e\n```\nAlias: ```/rt```\n\n##### Like / Favorite\n\n```\nbirdknife [---]\u003e /like \u003cid\u003e\n```\nAlias: ```/fav```\n\n##### Remove from likes / favorites\n\n```\nbirdknife [---]\u003e /unlike \u003cid\u003e\n```\nAlias: ```/unfav```\n\n##### Follow / Unfollow\n\n```\nbirdknife [---]\u003e /follow _vanita5\n```\n\n```\nbirdknife [---]\u003e /unfollow _vanita5\n```\n\n##### Block / Unblock\n\n```\nbirdknife [---]\u003e /block _vanita5\n```\n\n```\nbirdknife [---]\u003e /unblock _vanita5\n```\n\n##### Mute / Unmute\n\n```\nbirdknife [---]\u003e /mute _vanita5\n```\n\n```\nbirdknife [---]\u003e /unmute _vanita5\n```\n\n##### Mentions / Replies\n\n```\nbirdknife [---]\u003e /replies\n```\nShow recent mentions.\n\n##### Direct messages\n\n**Note: You can reply to dms directly with the ```/reply \u003cid\u003e``` command!** \n\n```\nbirdknife [---]\u003e /dms\n```\nDisplay direct messages inbox.\n\n```\nbirdknife [---]\u003e /dm _vanita5 Hello, this is a test from birdknife.\n```\nSend DMs to a user.\n\n##### Search\n\n```\nbirdknife [---]\u003e /search \u003cquery\u003e\n```\nSearch for tweets.\n\n##### Quit\n\n```\nbirdknife [---]\u003e /exit\n```\n\n##### Other commands\n\n```\n/again [screen_name]\n```\nReloads your timeline or loads recent tweets of a user if screen_name is given.\n\n\n```\n/delete \u003cid\u003e\n```\nDelete a tweet.\n\n```\n/user \u003cscreen_name\u003e\n```\nDisplay user information\n\n```\n/show \u003cid\u003e\n```\nDisplay a tweet with additional information.\n\n## Development\n\nFork, clone, `npm install`, code, pull request. :)\n\n\n## License\n\n```\n(The MIT License)\n\nCopyright (c) 2016 vanita5 \u003cmail@vanit.as\u003e\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n'Software'), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feliah-w%2Fbirdknife","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feliah-w%2Fbirdknife","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feliah-w%2Fbirdknife/lists"}