aryc v0.5.0
aryc
Usage
$ npm install -g aryc
$ aryc COMMAND
running command...
$ aryc (-v|--version|version)
aryc/0.5.0 darwin-arm64 node-v16.18.0
$ aryc --help [COMMAND]
USAGE
$ aryc COMMAND
...
Commands
aryc help [COMMAND]
display help for aryc
USAGE
$ aryc help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
aryc post-api [DIRECTORY]
Creates a file at the root of the directory specified containing all ARYC YML files. (ARYC version 1 File Structure)
USAGE
$ aryc post-api [DIRECTORY]
OPTIONS
-h, --help show CLI help
See code: src/commands/post-api.ts
aryc scan [DIRECTORY]
Scans the archive at the directory and creates aryc structure YAML files.
USAGE
$ aryc scan [DIRECTORY]
OPTIONS
-h, --help show CLI help
-j, --jimp Use Jimp processor for files under 2mb. Default: false
-u, --rootUrl=rootUrl [default: https://art.yuu.im] Define the base URL (omit trailing slash) of the archive
DESCRIPTION
Structure:
<root directory>/category/folder/artist/submission-title/<files go here>
See code: src/commands/scan.ts
aryc update [CHANNEL]
update the aryc CLI
USAGE
$ aryc update [CHANNEL]
See code: @oclif/plugin-update
Required file structure
/category/folder/artist/submission-title/files*.png
ex.
/originaldonotsteal/2020/example-guy/my-first-thing/file.png
Special cases
- the misc folder in any category root is excluded.
- any folder with a blank .aryc_ignore file in it will not be processed.
Reference case
References are archived using this schema:
/category/reference/current/ref.png
Required names:
- MUST be reference
- MUST be current
File Structure
Aryc File Structure refers to the schema used to store information. The current version of the Aryc File Structure is 1 released on January 21st, 2023
- Alpha: Not Versioned. Any files generated prior to 1/21/2023
- v1: Released 1/21/2022, Command Version 0.5.0
Things left to do
- When opening an .aryc_submission or .aryc_reference file, check to make sure the paths still resolve. Otherwise redo the file.