-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #15 from ArcaneDisgea/master
"better" cli?
- Loading branch information
Showing
2 changed files
with
158 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,22 @@ | ||
# lodestone-parser | ||
Parse lodestone for those juicy details | ||
|
||
- Run `php cli <func> <arg1> <arg2> <arg3>` for debugging | ||
- Run `php cli <func> <arguments>` for debugging | ||
- Run `php tests` to validate tests | ||
|
||
|CLI Command|Arguments|Description| | ||
|-|-|-| | ||
|`character`|`<id>`|Prints a character parse. | ||
|`freecompany`|`<id>`|Prints a freecompanies parse.| | ||
|`pvpteam`|`<id>`|Prints a pvpteam parse.| | ||
|`linkshell`|`<id>`|Prints a linkshell parse.| | ||
|`achievements`|`<id>`|Prints a characters achievement parse.| | ||
|`banners`|none|Prints the currently displayed banners on the lodestone homepage.| | ||
|`leaderboards`|`feast`,`potd`,`hoh`|Prints the current leaderboard parse for The Feast, Palace of The Dead, or Heaven on High.| | ||
|
||
All commands accept a flag to print the returned blob to a json file. | ||
Example | ||
``` | ||
// prints returned object to file myCharacter.json | ||
php cli character <lodestoneid> -file myCharacter | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters