Quellcode durchsuchen

add first idea for the cli command set
Please help with commands for git-deployment I haven't used that feature
yet

lukasepple vor 10 Jahren
Ursprung
Commit
78ec9c37eb
1 geänderte Dateien mit 22 neuen und 0 gelöschten Zeilen
  1. 22 0
      docs/hacking.md

+ 22 - 0
docs/hacking.md

@@ -266,6 +266,28 @@ set up the db for incremental builds, scaffold a new post, etc. for new users.
266 266
 Xach's buildapp or Fare's cl-launch would be useful here. frog and hakyll are
267 267
 reasonable points of inspiration for commands to offer.
268 268
 
269
+#### Commands
270
+
271
+(this is just a initial list of commands and what they'd do for the implementor. Feel free to contribute!)
272
+
273
+Imagine a executable `coleslaw`, the commands would be invoked like this: `coleslaw <commandname> <args>`
274
+
275
+* `build` generates the site. Takes:
276
+	* `--dir`: If not supplied `.` is used
277
+* `clean` removes the files from `output-dir` and `staging-dir`. Takes:
278
+	* `--dir`: If not supplied `.` is used
279
+* `rebuild` is a shortcut for `clean` and then `build`. Takes:
280
+	* `--dir`: If not supplied `.` is used
281
+* `post` creates a new empty `.post` file. Takes:
282
+	* `--dir`: If not supplied `.` is used
283
+	* `--title`: title (also used for generating file name)
284
+	* `--date`: same as the header-key. If not given, current time is used
285
+	* `--format`: same as the header-key
286
+	* …
287
+* `site` is the same as `post` but for static site (should we add this?)
288
+* `deploy`/`upload` does upload the files from `output-dir` to your (configured) webserver using rsync (?). Takes:
289
+	* `--dir`: If not supplied `.` is used
290
+
269 291
 ### Plugin Constraints
270 292
 
271 293
 There is no system for determining what plugins work together or