added docs for the new command

This commit is contained in:
pushrbx 2024-11-04 21:22:07 +00:00
parent e0cc44495b
commit 6568ff264e
No known key found for this signature in database
GPG Key ID: A16A474BBC2C91D9

View File

@ -14,14 +14,14 @@ For an entire list of commands, you can run `php artisan list`
- [Indexer](#indexer) - [Indexer](#indexer)
- [Anime](#indexer-anime) - [Anime](#indexer-anime)
- [Manga](#indexer-manga) - [Manga](#indexer-manga)
## Commands ## Commands
### Serve ### Serve
Command: `serve` Command: `serve`
Example: `php artisan serve` Example: `php artisan serve`
Serve the application on the PHP development server Serve the application on the PHP development server
### Queue ### Queue
@ -98,7 +98,7 @@ This function only needs to be run once. Any entry's cache updating will automat
Command: Command:
``` ```
indexer:anime indexer:manga
{--failed : Run only entries that failed to index last time} {--failed : Run only entries that failed to index last time}
{--resume : Resume from the last position} {--resume : Resume from the last position}
{--reverse : Start from the end of the array} {--reverse : Start from the end of the array}
@ -109,3 +109,16 @@ indexer:anime
Example: `indexer:manga` Example: `indexer:manga`
This simply translates to running the indexer without any additional configuration. This simply translates to running the indexer without any additional configuration.
#### Indexer: Incremental
Incrementally indexes media entries from MAL.
This command will compare the latest version of MAL ids from the [mal_id_cache](https://github.com/purarue/mal-id-cache)
github repository and compares them with the downloaded ids from the previous run. If no ids found from the previous run, a full indexing session is started.
Command:
```
indexer:incremental {mediaType*}
{--failed : Run only entries that failed to index last time}
{--resume : Resume from the last position}
{--delay=3 : Set a delay between requests}
```