aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBryan Newbold <bnewbold@archive.org>2021-02-10 22:07:54 -0800
committerBryan Newbold <bnewbold@archive.org>2021-02-10 22:07:54 -0800
commit174d1a2e831ed17b070f6da26bd8c654893b2ef8 (patch)
treea48684f566f62a2766af9afa0d3bbcbf15f2a447
parentd260c0fbcb3fd9c4f7c83af3f1e4fdd441c3d67d (diff)
downloadfatcat-cli-174d1a2e831ed17b070f6da26bd8c654893b2ef8.tar.gz
fatcat-cli-174d1a2e831ed17b070f6da26bd8c654893b2ef8.zip
README: fatcat -> fatcat-cli
-rw-r--r--README.md24
1 files changed, 13 insertions, 11 deletions
diff --git a/README.md b/README.md
index 35bc73d..5ebb7b9 100644
--- a/README.md
+++ b/README.md
@@ -1,8 +1,10 @@
<div align="center">
-<!-- https://www.flickr.com/photos/threecheersformcr_xo/5340309206/ -->
-<!-- TODO: move to an archive.org item... or just include in this repo -->
+<!-- TODO: move to an archive.org item... or just include file in this repo? -->
+<!-- attribution is at bottom of this page -->
+<a href="https://www.flickr.com/photos/threecheersformcr_xo/5340309206">
<img src="http://static.bnewbold.net/tmp/keyboard-cat-flickr-threecheersformcr_xo.jpg">
+</a>
</div>
`fatcat-cli`: api.fatcat.wiki command-line utility
@@ -41,15 +43,15 @@ the utility for their user. Unfortunately this will not include the manual
Query the catalog:
- fatcat search releases "metadata author:phillips"
+ fatcat-cli search releases "metadata author:phillips"
Fetch metadata for a specific work:
- fatcat get doi:10.1002/spe.659
+ fatcat-cli get doi:10.1002/spe.659
Download 100 papers from a specific journal, as PDF:
- fatcat search releases journal:"first monday" --entity-json --expand files | fatcat batch download --limit 100
+ fatcat-cli search releases journal:"first monday" --entity-json --expand files | fatcat-cli batch download --limit 100
### Authentication
@@ -69,7 +71,7 @@ project-management tool which does so already.
You can check the status of your authentication and connection to the server
with:
- fatcat status
+ fatcat-cli status
### Editing
@@ -83,22 +85,22 @@ to split up larger batches into editgroups of 50-100 changes at a time.
Individual entities can be edited from the convenience of your text editor, in
either JSON or TOML format:
- fatcat get release_hsmo6p4smrganpb3fndaj2lon4 --json > release_hsmo6p4smrganpb3fndaj2lon4.json
+ fatcat-cli get release_hsmo6p4smrganpb3fndaj2lon4 --json > release_hsmo6p4smrganpb3fndaj2lon4.json
# whatever editor you prefer
emacs release_hsmo6p4smrganpb3fndaj2lon4
- fatcat update release_hsmo6p4smrganpb3fndaj2lon4 < release_hsmo6p4smrganpb3fndaj2lon4.
+ fatcat-cli update release_hsmo6p4smrganpb3fndaj2lon4 < release_hsmo6p4smrganpb3fndaj2lon4.
json
Or, with a single command:
- fatcat edit release_hsmo6p4smrganpb3fndaj2lon4 --toml
+ fatcat-cli edit release_hsmo6p4smrganpb3fndaj2lon4 --toml
To check in on the status of recent editgroups, or to "submit" them for review:
- fatcat editgroups list
- fatcat editgroups submit editgroup_...
+ fatcat-cli editgroups list
+ fatcat-cli editgroups submit editgroup_...
## Thanks!