Kaynağa Gözat

simplified and clarified the cli

lukasepple 10 yıl önce
ebeveyn
işleme
86133fef8f
1 değiştirilmiş dosya ile 13 ekleme ve 13 silme
  1. 13 13
      docs/hacking.md

+ 13 - 13
docs/hacking.md

@@ -263,32 +263,32 @@ that are useful to the user. Example errors users have encountered:
263 263
 
264 264
 It would be convenient to add command-line tools/scripts to run coleslaw,
265 265
 set up the db for incremental builds, scaffold a new post, etc. for new users.
266
-Xach's buildapp or Fare's cl-launch would be useful here. frog and hakyll are
266
+Fukamachi's Shelly, 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 269
 #### Commands
270 270
 
271
-(this is just a initial list of commands and what they'd do for the implementor. Feel free to contribute!)
272
-
271
+This is a initial set of commands which will be used to implement the first coleslaw cli, feel free to contribute!
273 272
 Imagine a executable `coleslaw`, the commands would be invoked like this: `coleslaw <commandname> <args>`
274 273
 
275 274
 * `build` generates the site. Takes:
276
-	* `--dir`: If not supplied `.` is used
275
+	* `--repo-dir`: first defaults to `~/.coleslawrc`'s `repo-dir` then to `./.coleslawrc`'s `repo-dir` and otherwise fails
277 276
 * `clean` removes the files from `output-dir` and `staging-dir`. Takes:
278
-	* `--dir`: If not supplied `.` is used
277
+	* `--repo-dir`: See above
279 278
 * `rebuild` is a shortcut for `clean` and then `build`. Takes:
280
-	* `--dir`: If not supplied `.` is used
279
+	* `--repo-dir`: See above
281 280
 * `post` creates a new empty `.post` file. Takes:
282
-	* `--dir`: If not supplied `.` is used
281
+	* `--repo-dir`: See above
283 282
 	* `--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
283
+	* `--date`: same as the header-key. If not given, current time is used.
284
+	* `--format`: same as the header-key (optional, defaults to `md`)
286 285
 	* …
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
-* `git-deploy` adds the post-receive hook to a git repo specified with `--dir`
291 286
 * `serve` starts a hunchentoot serving the blog locally
287
+* maybe `page` which is `post` for static sites.
288
+
289
+Ideas for later:
290
+
291
+* handle deployment with commands but because we've got many methods there would have to be an intelligent way of handling that.
292 292
 
293 293
 ### Plugin Constraints
294 294