pwenker commited on
Commit
4d97dfb
Β·
1 Parent(s): 8a6cf84

docs: Update docs

Browse files
Files changed (2) hide show
  1. README.md +3 -3
  2. docs/cli.md +2 -2
README.md CHANGED
@@ -4,7 +4,7 @@ emoji: 🏰
4
  colorFrom: blue
5
  colorTo: red
6
  sdk: gradio
7
- app_file: app.py
8
  pinned: True
9
  ---
10
 
@@ -66,7 +66,7 @@ For more details, visit: [Basics - Rye](https://rye-up.com/guide/basics/)
66
  ### Start the App 🌟
67
 
68
  > [!NOTE]
69
- > If you choose to install `chessli2` without `rye`, or in case you activate the rye shell with `rye shell`, just omit `rye run` for the following commands.
70
 
71
  Launch the app using:
72
  ```
@@ -83,7 +83,7 @@ Thanks to [Gradio](https://www.gradio.app/), you can find an API documentation f
83
 
84
  ### CLI
85
 
86
- There is also a CLI, for usage information type:
87
  ```
88
  rye run chessli2 --help
89
  ```
 
4
  colorFrom: blue
5
  colorTo: red
6
  sdk: gradio
7
+ app_file: src/chessli/app.py
8
  pinned: True
9
  ---
10
 
 
66
  ### Start the App 🌟
67
 
68
  > [!NOTE]
69
+ > If you choose to install `chessli2` without `rye` just omit `rye run` for the following commands.
70
 
71
  Launch the app using:
72
  ```
 
83
 
84
  ### CLI
85
 
86
+ There is also a CLI!
87
  ```
88
  rye run chessli2 --help
89
  ```
docs/cli.md CHANGED
@@ -31,7 +31,7 @@ $ chessli2 mistakes [OPTIONS]
31
  **Options**:
32
 
33
  * `--src TEXT`: Select either the name of the Hugging Face Space to load, (e.g. "pwenker/chessli2") or the full URL (including "http" or "https") of the hosted Gradio app to load (e.g. "http://localhost:7860/" or "https://bec81a83-5b5c-471e.gradio.live/ [default: pwenker/chessli2]
34
- * `--lichess-api-token TEXT`: Select lichess API token [default: lip_5tGPs3qUPcYoWpSnEZfH]
35
  * `--user-name TEXT`: Select user name [default: pwenker]
36
  * `--start-date TEXT`: Select start date (YYYY-MM-DD) [default: 2017-05-14]
37
  * `--end-date TEXT`: Select end date (YYYY-MM-DD) [default: 2024-05-14]
@@ -53,7 +53,7 @@ $ chessli2 puzzles [OPTIONS]
53
  **Options**:
54
 
55
  * `--src TEXT`: Select either the name of the Hugging Face Space to load, (e.g. 'pwenker/chessli2') or the full URL (including 'http' or 'https') of the hosted Gradio app to load (e.g. 'http://localhost:7860/' or 'https://bec81a83-5b5c-471e.gradio.live/') [default: http://pwenker.github.io/chessli2/]
56
- * `--lichess-api-token TEXT`: Select lichess API token [default: lip_5tGPs3qUPcYoWpSnEZfH]
57
  * `--before TEXT`: Only get puzzle activity before this date (format YYYY-MM-DD) [default: 2024-05-15]
58
  * `--max INTEGER`: Select maxmimum number of puzzles [default: 100]
59
  * `--themes [Advanced pawn|Advantage|Anastasia's mate|Arabian mate|Attacking f2 or f7|Attraction|Back rank mate|Bishop endgame|Boden's mate|Castling|Capture the defender|Crushing|Double bishop mate|Dovetail mate|Equality|Kingside attack|Clearance|Defensive move|Deflection|Discovered attack|Double check|Endgame|Exposed king|Fork|Hanging piece|Hook mate|Interference|Intermezzo|Knight endgame|Long puzzle|Master games|Master vs Master games|Checkmate|Mate in 1|Mate in 2|Mate in 3|Mate in 4|Mate in 5 or more|Middlegame|One-move puzzle|Opening|Pawn endgame|Pin|Promotion|Queen endgame|Queen and Rook|Queenside attack|Quiet move|Rook endgame|Sacrifice|Short puzzle|Skewer|Smothered mate|Super GM games|Trapped piece|Underpromotion|Very long puzzle|X-Ray attack|Zugzwang|Healthy mix|Player games]`: Filter by puzzle themes [default: Advanced pawn, Advantage, Anastasia's mate, Arabian mate, Attacking f2 or f7, Attraction, Back rank mate, Bishop endgame, Boden's mate, Castling, Capture the defender, Crushing, Double bishop mate, Dovetail mate, Equality, Kingside attack, Clearance, Defensive move, Deflection, Discovered attack, Double check, Endgame, Exposed king, Fork, Hanging piece, Hook mate, Interference, Intermezzo, Knight endgame, Long puzzle, Master games, Master vs Master games, Checkmate, Mate in 1, Mate in 2, Mate in 3, Mate in 4, Mate in 5 or more, Middlegame, One-move puzzle, Opening, Pawn endgame, Pin, Promotion, Queen endgame, Queen and Rook, Queenside attack, Quiet move, Rook endgame, Sacrifice, Short puzzle, Skewer, Smothered mate, Super GM games, Trapped piece, Underpromotion, Very long puzzle, X-Ray attack, Zugzwang, Healthy mix, Player games]
 
31
  **Options**:
32
 
33
  * `--src TEXT`: Select either the name of the Hugging Face Space to load, (e.g. "pwenker/chessli2") or the full URL (including "http" or "https") of the hosted Gradio app to load (e.g. "http://localhost:7860/" or "https://bec81a83-5b5c-471e.gradio.live/ [default: pwenker/chessli2]
34
+ * `--lichess-api-token TEXT`: Select lichess API token [default: your lichess API token in .env, e.g. lip_5tGPs3qUPcYoWpSnEZfH]
35
  * `--user-name TEXT`: Select user name [default: pwenker]
36
  * `--start-date TEXT`: Select start date (YYYY-MM-DD) [default: 2017-05-14]
37
  * `--end-date TEXT`: Select end date (YYYY-MM-DD) [default: 2024-05-14]
 
53
  **Options**:
54
 
55
  * `--src TEXT`: Select either the name of the Hugging Face Space to load, (e.g. 'pwenker/chessli2') or the full URL (including 'http' or 'https') of the hosted Gradio app to load (e.g. 'http://localhost:7860/' or 'https://bec81a83-5b5c-471e.gradio.live/') [default: http://pwenker.github.io/chessli2/]
56
+ * `--lichess-api-token TEXT`: Select lichess API token [default: your lichess API token in .env, e.g. lip_5tGPs3qUPcYoWpSnEZfH]
57
  * `--before TEXT`: Only get puzzle activity before this date (format YYYY-MM-DD) [default: 2024-05-15]
58
  * `--max INTEGER`: Select maxmimum number of puzzles [default: 100]
59
  * `--themes [Advanced pawn|Advantage|Anastasia's mate|Arabian mate|Attacking f2 or f7|Attraction|Back rank mate|Bishop endgame|Boden's mate|Castling|Capture the defender|Crushing|Double bishop mate|Dovetail mate|Equality|Kingside attack|Clearance|Defensive move|Deflection|Discovered attack|Double check|Endgame|Exposed king|Fork|Hanging piece|Hook mate|Interference|Intermezzo|Knight endgame|Long puzzle|Master games|Master vs Master games|Checkmate|Mate in 1|Mate in 2|Mate in 3|Mate in 4|Mate in 5 or more|Middlegame|One-move puzzle|Opening|Pawn endgame|Pin|Promotion|Queen endgame|Queen and Rook|Queenside attack|Quiet move|Rook endgame|Sacrifice|Short puzzle|Skewer|Smothered mate|Super GM games|Trapped piece|Underpromotion|Very long puzzle|X-Ray attack|Zugzwang|Healthy mix|Player games]`: Filter by puzzle themes [default: Advanced pawn, Advantage, Anastasia's mate, Arabian mate, Attacking f2 or f7, Attraction, Back rank mate, Bishop endgame, Boden's mate, Castling, Capture the defender, Crushing, Double bishop mate, Dovetail mate, Equality, Kingside attack, Clearance, Defensive move, Deflection, Discovered attack, Double check, Endgame, Exposed king, Fork, Hanging piece, Hook mate, Interference, Intermezzo, Knight endgame, Long puzzle, Master games, Master vs Master games, Checkmate, Mate in 1, Mate in 2, Mate in 3, Mate in 4, Mate in 5 or more, Middlegame, One-move puzzle, Opening, Pawn endgame, Pin, Promotion, Queen endgame, Queen and Rook, Queenside attack, Quiet move, Rook endgame, Sacrifice, Short puzzle, Skewer, Smothered mate, Super GM games, Trapped piece, Underpromotion, Very long puzzle, X-Ray attack, Zugzwang, Healthy mix, Player games]