haxor-news
Coworker who sees me looking at something in a browser: "Glad you're not busy; I need you to do this, this, this..."
Coworker who sees me staring intently at a command prompt: Backs away, slowly...
Check out the haxor-news discussion in this Hacker News post.
haxor-news brings Hacker News to the terminal, allowing you to view/filter the following without leaving your command line:
- Posts
- Post Comments
- Post Linked Web Content
- Monthly Hiring and Freelancers Posts
- User Info
- Onions
haxor-news helps you filter the large number of comments that popular posts generate.
- Want to expand only previously unseen comments?
-cu/--comments_unseen
- How about recent comments posted in the past 60 minutes?
-cr/--comments_recent
- Filter comments matching a regex query?
-cq/--comments_query [query]
Job hunting or just curious what's out there? Filter the monthly who's hiring and freelancers post:
$ hn hiring "(?i)(Node|JavaScript).*(remote)" > remote_web_jobs.txt
Combine haxor-news with pipes, redirects, and other command line utilities. Output to pagers, write to files, automate with cron, etc.
haxor-news comes with a handy optional auto-completer with interactive help:
Index
General
Features
- View Posts
- View a Post's Linked Web Content
- View and Filter a Post's Comments
- View and Filter the Monthly Hiring Post
- View and Filter the Monthly Freelancer Post
- Combine With Pipes and Redirects
- View User Info
- View Onions
- View Results in a Browser
- Windows Support
Installation and Tests
Misc
Syntax
Usage:
$ hn [params] [options]
Auto-Completer and Interactive Help
Optionally, you can enable fish-style completions and an auto-completion menu with interactive help:
$ haxor-news
If available, the auto-completer also automatically displays comments through a pager.
Within the auto-completer, the same syntax applies:
haxor> hn [params] [options]
Customizable Highlighting
You can control the ansi colors used for highlighting by updating your ~/.haxornewsconfig file.
Color options include:
'black', 'red', 'green', 'yellow',
'blue', 'magenta', 'cyan', 'white'
For no color, set the value(s) to None.
Commands
View Posts
View the Top, Best, Show, Ask, Jobs, New, and Onion posts.
Usage:
$ hn [command] [limit] # post limit default: 10
Examples:
$ hn top
$ hn show 20
View a Post's Linked Web Content
After viewing a list of posts, you can view a post's linked web content by referencing the post #.
The HTML contents of the post's link are formatted for easy-viewing within your terminal. If available, the formatted output is sent to a pager.
See the View in a Browser section to view the contents in a browser instead.
Usage:
$ hn view [#]
Example:
$ hn view 1
$ hn view 8
View and Filter a Post's Comments
View All Comments
After viewing a list of posts, you can view a post's comments by referencing the post #.
Examples:
$ hn view 8 -c
$ hn view 8 --comments > comments.txt
Paged Comments
If running with the auto-completer, comments are automatically paginated. To get the same pagination without the auto-completer, append | less -r:
$ hn view 8 -c | less -r
Filter on Unseen Comments
Filter comments to expand only those you have not yet seen. Unseen comments are denoted with a [!] and are fully expanded.
Seen comments will be truncated with [...] and will be shown to help provide context to unseen comments.
Examples:
$ hn view 8 -cu
$ hn view 8 --comments_unseen | less -r
Filter on Recent Comments
Filter comments to expand only those posted within the past 60 minutes.
Older comments will be truncated with [...] and will be shown to help provide context to recent comments.
Examples:
$ hn view 8 -cr | less -r
$ hn view 8 --comments_recent
Filter with Regex
Filter comments based on a given regular expression query.
Examples:
$ hn view 2 -cq "(?i)programmer" | less -r
$ hn view 2 --comments_regex_query "(?i)programmer" > programmer.txt
Case insensitive regex: (?i)
Hide Non-Matching Comments
When filtering comments for unseen, recent, or with regex, non-matching comments are collapsed to provide context. To instead hide non-matching comments, pass the -ch\--comments_hide flag. Hidden comments will be displayed as ..
Example:
$ hn view 8 -cu -ch | less -r
Filter the Monthly Hiring Post
Hacker News hosts a monthly hiring post where employers post the latest job openings.
Usage:
$ hn hiring [regex filter]
Examples:
$ hn hiring ""
$ hn hiring "(?i)JavaScript|Node"
$ hn hiring "(?i)(Node|JavaScript).*(remote)" > remote_jobs.txt
Case insensitive regex: (?i)
To search a different monthly hiring post other than the latest, use the hiring post id.
Usage:
$ hn hiring [regex filter] [post id]
Filter the Freelancers Post
Hacker News hosts a monthly freelancers post where employers and freelancers post availabilities.
Usage:
$ hn freelance [regex filter]
Examples:
$ hn freelance ""
$ hn freelance "(?i)JavaScript|Node"
$ hn freelance "(?i)(Node|JavaScript).*(remote)" > remote_jobs.txt
Case insensitive regex: (?i)
To search a different monthly hiring post other than the latest, use the hiring post id.
Usage:
$ hn freelance [regex filter] [post id]
Combine With Pipes and Redirects
Output to pagers, write to files, automate with cron, etc.
Examples:
$ hn view 1 -c | less
$ hn freelance "(?i)(Node|JavaScript).*(remote)" > remote_jobs.txt
View User Info
Usage:
$ hn user [user id]
View Onions
Usage:
$ hn onion [limit] # post limit default: all
View in a Browser
View the linked web content or comments in your default browser instead of your terminal.
Usage:
$ hn [params] [options] -b
$ hn [params] [options] --browser
Windows Support
haxor-news has been tested on Windows 10.
Pager Support
Pager support on Windows is more limited as discussed in the following ticket. Users can direct output to a pager with the | more command:
$ hn view 1 -c | more
Config File
On Windows, the .haxornewsconfig file can be found in %userprofile%. For example:
C:\Users\dmartin\.haxornewsconfig
cmder and conemu
Although you can use the standard Windows command prompt, you'll probably have a better experience with either cmder or conemu.
Installation
Pip Installation
haxor-news is hosted on PyPI. The following command will install haxor-news:
$ pip install haxor-news
You can also install the latest haxor-news from GitHub source which can contain changes not yet pushed to PyPI:
$ pip install git+https://github.com/donnemartin/haxor-news.git
If you are not installing in a virtualenv, run with sudo:
$ sudo pip install haxor-news
Once installed, run the optional haxor-news auto-completer with interactive help:
$ haxor-news
Run commands:
$ hn [params] [options]
Virtual Environment Installation
It is recommended that you install Python packages in a virtualenv to avoid potential issues with dependencies or permissions.
To view haxor-news virtualenv installation instructions, click here.
Mac OS X 10.11 El Capitan Users
There is a known issue with Apple and its included python package dependencies (more info at https://github.com/pypa/pip/issues/3165). We are investigating ways to fix this issue but in the meantime, to install haxor-news, you can run:
$ sudo pip install haxor-news --upgrade --ignore-installed six
Supported Python Versions
- Python 2.6
- Python 2.7
- Python 3.3
- Python 3.4
- Python 3.5
- Python 3.6
- Python 3.7
Supported Platforms
- Mac OS X
- Tested on OS X 10.10
- Linux, Unix
- Tested on Ubuntu 14.04 LTS
- Windows
- Tested on Windows 10
Developer Installation
If you're interested in contributing to haxor-news, run the following commands:
$ git clone https://github.com/donnemartin/haxor-news.git
$ pip install -e .
$ pip install -r requirements-dev.txt
$ haxor-news
$ hn [params] [options]
Continuous Integration
Continuous integration details are available on Travis CI.
Unit Tests and Code Coverage
Run unit tests in your active Python environment:
$ python tests/run_tests.py
Run unit tests with tox on multiple Python environments:
$ tox
Documentation
Source code documentation will soon be available on Readthedocs.org. Check out the source docstrings.
Run the following to build the docs:
$ scripts/update_docs.sh
Contributing
Contributions are welcome!
Review the Contributing Guidelines for details on how to:
- Submit issues
- Submit pull requests
Credits
- click by mitsuhiko
- haxor by avinassh
- html2text by aaronsw
- python-prompt-toolkit by jonathanslenders
- requests by kennethreitz
Contact Info
Feel free to contact me to discuss any issues, questions, or comments.
My contact info can be found on my GitHub page.
License
I am providing code and resources in this repository to you under an open source license. Because this is my personal repository, the license you receive to my code and resources is from me and not my employer (Facebook).
Copyright 2015 Donne Martin
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
17 Dec 11, 2022
2 Apr 20, 2022
5.8k Jan 3, 2023
5.1k Jan 5, 2023
3.4k Dec 30, 2022
23 Jun 29, 2022
16 Oct 15, 2022
5 Nov 19, 2021
10 Dec 24, 2022
13 Oct 14, 2022
166 Dec 30, 2022
19 Jul 20, 2022
5.9k Jan 4, 2023
2 Apr 4, 2022
5 Apr 12, 2022
30 Sep 8, 2022
8 Nov 29, 2022
3 Jan 10, 2022