{"ok":true,"site":"archive","host":"archive.org","about":"Internet Archive (archive.org): a digital library of texts, audio, video, software and web snapshots. This CLI searches items, including full-text search inside books, browses collections and user uploads, reads item metadata, file lists, reviews and OCR text, downloads files, and queries Wayback Machine snapshots.","commands":[{"command":"search-items","summary":"Keyword search across archive.org items, as the archive.org/search UI does it, with facet filters, sort and paging; set service_backend=fts to search inside book text","params":[{"name":"query","type":"string","required":true,"description":"Search terms. Lucene-style field queries are allowed, e.g. 'grateful dead' or 'title:(moby dick)'"},{"name":"filter_map","type":"string","description":"JSON facet filter. Map each field to {value: op}, where op is inc, exc, gte or lte. Example: {\"mediatype\":{\"texts\":\"inc\"},\"year\":{\"1900\":\"gte\",\"1950\":\"lte\"},\"language\":{\"English\":\"inc\"}}"},{"name":"sort","type":"string","description":"Sort order as field:direction. Omit for relevance.","oneOf":["downloads:desc","week:desc","publicdate:desc","addeddate:desc","date:desc","date:asc","title:asc","creator:asc","reviewdate:desc"]},{"name":"service_backend","type":"string","description":"Search backend: 'metadata' (the default when omitted) or 'fts' for full-text search inside documents","oneOf":["metadata","fts"]},{"name":"hits_per_page","type":"number","description":"Results per page (the UI uses 50 or 100)","default":50},{"name":"page","type":"number","description":"1-based page number","default":1}],"exampleUrl":"https://clify-dev.netlify.app/archive/search-items?query=grateful+dead&filter_map=%7B%22mediatype%22%3A%7B%22audio%22%3A%22inc%22%7D%7D&sort=downloads%3Adesc"},{"command":"list-collection-items","summary":"List the items in a collection (e.g. GratefulDead, texts, audio), with sort, facet filters and paging","params":[{"name":"collection","type":"string","required":true,"description":"Collection identifier, e.g. GratefulDead, etree, texts, librivoxaudio"},{"name":"query","type":"string","description":"Optional search terms to search within the collection"},{"name":"filter_map","type":"string","description":"JSON facet filter, e.g. {\"year\":{\"1977\":\"inc\"}}"},{"name":"sort","type":"string","description":"Sort order as field:direction","oneOf":["downloads:desc","week:desc","publicdate:desc","addeddate:desc","date:desc","date:asc","title:asc","creator:asc","reviewdate:desc"]},{"name":"hits_per_page","type":"number","description":"Results per page","default":50},{"name":"page","type":"number","description":"1-based page number","default":1}],"exampleUrl":"https://clify-dev.netlify.app/archive/list-collection-items?collection=GratefulDead&sort=publicdate%3Adesc"},{"command":"list-user-uploads","summary":"List the public uploads of an archive.org user account","params":[{"name":"user","type":"string","required":true,"description":"Account screen name prefixed with @, e.g. @matthew_vernon"},{"name":"sort","type":"string","description":"Sort order as field:direction","oneOf":["downloads:desc","publicdate:desc","addeddate:desc","date:desc","title:asc"]},{"name":"hits_per_page","type":"number","description":"Results per page","default":50},{"name":"page","type":"number","description":"1-based page number","default":1}],"exampleUrl":"https://clify-dev.netlify.app/archive/list-user-uploads?user=%40matthew_vernon"},{"command":"advanced-search","summary":"Solr-style advanced search (advancedsearch.php) returning identifier, title, creator, mediatype, date and downloads, with sort and paging","params":[{"name":"q","type":"string","required":true,"description":"Lucene query, e.g. 'grateful dead AND mediatype:audio' or 'collection:GratefulDead AND year:1977'"},{"name":"sort","type":"string","description":"Sort as 'field asc|desc', e.g. 'downloads desc', 'date asc', 'publicdate desc'"},{"name":"rows","type":"number","description":"Results per page","default":50},{"name":"page","type":"number","description":"1-based page number","default":1}],"exampleUrl":"https://clify-dev.netlify.app/archive/advanced-search?q=grateful+dead+AND+mediatype%3Aaudio&sort=downloads+desc"},{"command":"scrape-items","summary":"Bulk-list every item matching a query with the cursor-based scrape API; suited to enumerating large collections","params":[{"name":"q","type":"string","required":true,"description":"Lucene query, e.g. collection:GratefulDead"},{"name":"api_fields","type":"string","description":"Comma-separated metadata fields to return (sent to the site as \"fields\"; clify's own --fields only shapes the output)","default":"identifier,title,date"},{"name":"count","type":"number","description":"Items per request (minimum 100)","default":100},{"name":"cursor","type":"string","description":"Cursor from the previous response, used to fetch the next batch"}],"exampleUrl":"https://clify-dev.netlify.app/archive/scrape-items?q=collection%3AGratefulDead"},{"command":"get-item-metadata","summary":"Get an item's descriptive metadata (title, creator, date, collection, description and more) by identifier","params":[{"name":"identifier","type":"string","required":true,"description":"Item identifier (the part after /details/)"}],"exampleUrl":"https://clify-dev.netlify.app/archive/get-item-metadata"},{"command":"list-item-files","summary":"List the files in an item, with name, format, size and checksums; pass a name to download-file","params":[{"name":"identifier","type":"string","required":true,"description":"Item identifier"}],"exampleUrl":"https://clify-dev.netlify.app/archive/list-item-files"},{"command":"get-item-reviews","summary":"Get the user reviews (title, body, reviewer, stars, date) posted on an item","params":[{"name":"identifier","type":"string","required":true,"description":"Item identifier"}],"exampleUrl":"https://clify-dev.netlify.app/archive/get-item-reviews"},{"command":"get-item-fulltext","summary":"Get the full OCR plain text of a text item (book or document)","params":[{"name":"identifier","type":"string","required":true,"description":"Identifier of a texts item"}],"exampleUrl":"https://clify-dev.netlify.app/archive/get-item-fulltext"},{"command":"download-file","summary":"Download one file from an item (text files are returned as text)","params":[{"name":"identifier","type":"string","required":true,"description":"Item identifier"},{"name":"file","type":"string","required":true,"description":"File name as listed by list-item-files"}],"exampleUrl":"https://clify-dev.netlify.app/archive/download-file"},{"command":"get-collection-views","summary":"Get view statistics for a collection over the last N days, broken down by country and region","params":[{"name":"collection","type":"string","required":true,"description":"Collection identifier"},{"name":"days","type":"number","description":"Number of days to look back","default":30}],"exampleUrl":"https://clify-dev.netlify.app/archive/get-collection-views"},{"command":"list-user-lists","summary":"Get a user's public item lists and the items each one contains","params":[{"name":"username","type":"string","required":true,"description":"Account screen name without the leading @"}],"exampleUrl":"https://clify-dev.netlify.app/archive/list-user-lists"},{"command":"list-top-collections","summary":"List the top collections featured on the archive.org home page, with item counts","params":[{"name":"page","type":"number","description":"1-based page number","default":1},{"name":"count","type":"number","description":"Collections per page","default":50}],"exampleUrl":"https://clify-dev.netlify.app/archive/list-top-collections?page=1&count=50"},{"command":"get-media-counts","summary":"Get total item counts per media type (texts, movies, audio, software, image, etree, tv, web)","params":[],"exampleUrl":"https://clify-dev.netlify.app/archive/get-media-counts"},{"command":"wayback-available","summary":"Find the Wayback Machine snapshot of a URL closest to a given timestamp","params":[{"name":"url","type":"string","required":true,"description":"URL or domain to look up, e.g. example.com"},{"name":"timestamp","type":"string","description":"Target time as YYYYMMDDhhmmss (a prefix is fine, e.g. 20100101). Omit to get the latest snapshot."}],"exampleUrl":"https://clify-dev.netlify.app/archive/wayback-available?url=example.com&timestamp=20100101"},{"command":"list-wayback-snapshots","summary":"List Wayback Machine captures of a URL from the CDX index, optionally limited to a date range","params":[{"name":"url","type":"string","required":true,"description":"URL to list captures for, e.g. example.com"},{"name":"from","type":"string","description":"Start of the range as a YYYYMMDDhhmmss prefix, e.g. 2010"},{"name":"to","type":"string","description":"End of the range as a YYYYMMDDhhmmss prefix, e.g. 2012"},{"name":"matchType","type":"string","description":"How to match the url","oneOf":["exact","prefix","host","domain"]},{"name":"collapse","type":"string","description":"Collapse adjacent duplicate captures on a field, e.g. digest or timestamp:8 (one per day)"},{"name":"api_limit","type":"number","description":"Maximum number of rows (sent to the site as \"limit\"; clify's own --limit only shapes the output)","default":50}],"exampleUrl":"https://clify-dev.netlify.app/archive/list-wayback-snapshots?url=example.com&api_limit=20"}]}