Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cannibalox/movie-cli-2
A CLI tool to fetch and save movie details from omdb and comparing two movies. Nice for tracking watched movies in Logseq.
https://github.com/cannibalox/movie-cli-2
cli fetch logseq movies omdb shell-script terminal
Last synced: 3 months ago
JSON representation
A CLI tool to fetch and save movie details from omdb and comparing two movies. Nice for tracking watched movies in Logseq.
- Host: GitHub
- URL: https://github.com/cannibalox/movie-cli-2
- Owner: cannibalox
- License: mit
- Fork: true (mayankchd/movie)
- Created: 2022-08-09T21:35:18.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-01-17T21:30:49.000Z (about 2 years ago)
- Last Synced: 2024-08-03T19:08:04.136Z (6 months ago)
- Topics: cli, fetch, logseq, movies, omdb, shell-script, terminal
- Language: JavaScript
- Homepage:
- Size: 459 KB
- Stars: 4
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-logseq - movie-cli-2 - CLI tool for saving movie details into Logseq (🔍 CLI Tools and Scripts / Bibliography and PDF Integrations)
README
# movie-cli-2
a CLI tool to fetch movies and tv series details from omdbApi.com and tmdb, or comparing two movies.
It can optionally save the movie metadata to the clipboard or as a markdown file in a custom folder. Metadata will be formatted as `property:: value` for Logseq note-taking app.
version : 1.1.0 2022-01-17
# install
```
npm i -g github:cannibalox/movie-cli-2
```
## requirements :
- NodeJS > 17.5
- an api key from [omdbapi.com](https://www.omdbapi.com/apikey.aspx) to fetch movie details
- a [TMDB api key](https://developers.themoviedb.org/) is required to fetch "original title" property
# USAGE
open a terminal and type `movie` followed by search terms
```
Usage: movie [title] or [movie1]::[movie2]
Options:
-v, --version output the current version
-k, --key set and save your apîkeys
-r, --reset resets options and clear keys
-s, --settings define settings
-h, --help display help for command
```
terminal showing info (left) | movie info saved as a md file inside Logseq (right)
demo
## configuration
- on first start, the program should enter configuration mode and will let you choose options (eg: define which metadata to fetch, auto-save to clipboard, etc...)
- please get your own api keys for omdbapi (https://www.omdbapi.com/apikey.aspx) and TMDB (https://www.themoviedb.org/settings/api)
- the configuration is automatically saved, use `movie -v` to see the location of the config file
- use `movie --reset` or `movie --settings` to modify the configuration after the first run
setup screen
### for logseq users:
- the movie metadata can be saved as a markdown file as `property:: value`. It can add a `title::` and fill default `tags::`
- don't forget to set your date format in the config file to match your logseq date format (like yyyymmdd | yyyy-mm-dd | dddd, MMM do, yyyy | etc...)
(refer to logseq docs and https://github.com/felixge/node-dateformat#mask-options to see available formats)
- the script can optionally ask for a custom rating and watched date, they will be saved as properties `rating::` and `watched:: [[%date%]]` (a few custom arguments are possible)
- filepaths should point to your logseq journals and logseq pages folder (eg: 'c:\\logseq-graph\\journals', 'd:/logseq/pages' or '/Users/path/to/logseq/pages/or/journal/'). Test the output on a temp folder beforehand.
the folders must exist prior to the execution. the trailing `\` or `/` is not required.
- the script can optionally set a log line in the daily journal at the %watched date% defined for the movie
## new features and improvements
the script is forked from Mayankchd's [movie-cli](https://github.com/mayankchd/movie/blob/master/cli.js), tailored for my personal movie tracking workflow in Logseq.
notable differences and new features :
- added a list of matching titles to pick from, to disambiguate titles like `Alone (2008)` vs `Alone (2020)`
- added save to clipboard and save to file options
- added `original-title::` property using TMDB api for non-English titles
- added custom inputs (ratings, watched date)
- refactor code, updated to ECMAScript modules, update dependencies and removed isomorphic-fetch.
## limitations
in case of errors, try `mmovie -r` or `movie -s` to reset the settings.
only supports markdown, not org-mode format.
the daily page log is crude : it doesn't rely on the logseq API, it's only appending a line at the end of the md file.
use with wisdom and be careful of your data : backup your logseq folders, test outputs in a temp folder.