README
¶
Installation
go install github.com/mfederowicz/trakt-sync@latest
Configuration
After install, we should create API app and save credentials in config file ($HOME/trakt-sync.toml):
client_id = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
client_secret = "xxxxxxxxxxxxxxxxxxxxxxxxxxxx"
token_path = "~/.config/trakt-sync/token.json"
errorCode = 0
warningCode = 0
per_page = 500
pages_limit = 10
Usage
trakt-sync supports a -config flag whose value should correspond to a TOML file.
If not provided, trakt-sync will try to use a global config file (assumed to be located at $HOME/trakt-sync.toml).
Otherwise, if no configuration TOML file is found then trakt-sync uses a built-in parameters depends on selected module.
Command Line Flags
trakt-sync accepts the following command line parameters:
-config [PATH]- path to config file in TOML format, defaults to$HOME/trakt-sync.tomlif present.-version- get trakt-sync version.
Command Line Commands
trakt-sync accepts the following command line commands/modules:
calendars- By default, the calendar will return all shows or movies for the specified time period and can be global or user specific.certifications- Certifications listcheckin- Checkin movie,episode,show_episode,deletecomments- Comments comments,comment,replies,item,likes,like,trending,recent,updates.collection- Get all collected items in a user's collection.countries- Get a list of all countries, including names and codes.genres- Get a list of all genres, including names and slugs.help- Help on the trakt-sync command and subcommands.history- Returns movies and episodes that a user has watched, sorted by most recent.languages- Get a list of all laguages, including names and codes.lists- Returns data about lists: trending, popular, list, likes, like, items, comments.movies- Returns data about movies: trending, popular, list, likes, like, items, comments etc...networks- Get a list of all TV networksnotes- Manage notes created by userpeople- Returns all data for selected person.recommendations- Recommendations manage movie and shows recommendations for userscrobble- Scrobble for start/pause/stop movie,show,episodesearch- Searches can use queries or ID lookups.seasons- Returns data about seasons: summary, season, episodes, translations, comments etc...shows- Returns data about movies: trending, popular, list, likes, like, items, comments etc...sync- Sync data useful for mediacenters: activities, playbacks, collections, ratings, watchlists, favorites.users- Returns all data for a user.watchlist- Returns all items in a user's watchlist filtered by type.
License
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package buffer used to write buffer bytes and printout logs if exists
|
Package buffer used to write buffer bytes and printout logs if exists |
|
Package cfg used for process configuration
|
Package cfg used for process configuration |
|
Package cli for basic cli functions
|
Package cli for basic cli functions |
|
Package cmds used for commands modules
|
Package cmds used for commands modules |
|
Package consts used to store const for application
|
Package consts used to store const for application |
|
Package handlers used to handle module actions
|
Package handlers used to handle module actions |
|
Package internal used for client and services
|
Package internal used for client and services |
|
Package printer is replacement for fmt.* functions
|
Package printer is replacement for fmt.* functions |
|
Package str used for structs
|
Package str used for structs |
|
Package test used for process tests
|
Package test used for process tests |
|
Package uri used for url operations
|
Package uri used for url operations |
|
Package writer used for write operations
|
Package writer used for write operations |
Click to show internal directories.
Click to hide internal directories.