Project

tsumanne

0.0
The project is in a healthy, maintained state
This gem provide unofficial API of tsumanne.net, an archiving site of 2chan.net
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

Runtime

 Project Readme

Tsumanne

Rake Release Gem Gem Version

API Wrapper for tsumanne.net

Installation

gem install tsumanne

Usage

See: spec/tsumanne_spec.rb

CLI

tsumanne [global options] <command> [options] [arguments]

The board to talk to is a global option, so it comes before the command: -b/--board takes one of img (default), may, jun, dat, special.

Command Description
threads List the archived threads of a board (--index, --page)
thread Print an archived thread, by id or by YYYY/MM/DD/<thread id> archive path
search Find the archived thread of a 2chan.net thread URI
indexes List the indexes, or search them by keyword (--keyword, --order, --page)
register Ask the site to archive a 2chan.net thread (--index, repeatable)
# list the second page of the `may` board
tsumanne --board may threads --page 2

# save an archived thread
tsumanne thread 1234567890 > thread.mht

# look up which archive a thread ended up in
tsumanne search https://may.2chan.net/b/res/1234567890.htm

# search the indexes, ordered by name instead of by newest
tsumanne indexes --keyword ねこ --order hira

# request to archive a thread
tsumanne register https://may.2chan.net/b/res/1234567890.htm

Development

# install dependencies
bundle

# check code with linter / formatter && run tests
rake

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/eggplants/tsumanne.

License

The gem is available as open source under the terms of the MIT License.