marcuskammer/coleslaw
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

simplified and clarified the cli

Browse source
This commit is contained in:
lukasepple 2014-12-08 20:04:45 +01:00
parent e52a9765a5
commit 86133fef8f
1 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
docs/hacking.md
View file

@ -263,32 +263,32 @@ that are useful to the user. Example errors users have encountered:
It would be convenient to add command-line tools/scripts to run coleslaw,
set up the db for incremental builds, scaffold a new post, etc. for new users.
Xach's buildapp or Fare's cl-launch would be useful here. frog and hakyll are
Fukamachi's Shelly, Xach's buildapp or Fare's cl-launch would be useful here. frog and hakyll are
reasonable points of inspiration for commands to offer.
#### Commands
(this is just a initial list of commands and what they'd do for the implementor. Feel free to contribute!)
This is a initial set of commands which will be used to implement the first coleslaw cli, feel free to contribute!
Imagine a executable `coleslaw`, the commands would be invoked like this: `coleslaw <commandname> <args>`
* `build` generates the site. Takes:
* `--dir`: If not supplied `.` is used
* `--repo-dir`: first defaults to `~/.coleslawrc`'s `repo-dir` then to `./.coleslawrc`'s `repo-dir` and otherwise fails
* `clean` removes the files from `output-dir` and `staging-dir`. Takes:
* `--dir`: If not supplied `.` is used
* `--repo-dir`: See above
* `rebuild` is a shortcut for `clean` and then `build`. Takes:
* `--dir`: If not supplied `.` is used
* `--repo-dir`: See above
* `post` creates a new empty `.post` file. Takes:
* `--dir`: If not supplied `.` is used
* `--repo-dir`: See above
* `--title`: title (also used for generating file name)
* `--date`: same as the header-key. If not given, current time is used
* `--format`: same as the header-key
* `--date`: same as the header-key. If not given, current time is used.
* `--format`: same as the header-key (optional, defaults to `md`)
* …
* `site` is the same as `post` but for static site (should we add this?)
* `deploy`/`upload` does upload the files from `output-dir` to your (configured) webserver using rsync (?). Takes:
* `--dir`: If not supplied `.` is used
* `git-deploy` adds the post-receive hook to a git repo specified with `--dir`
* `serve` starts a hunchentoot serving the blog locally
* maybe `page` which is `post` for static sites.
Ideas for later:
* handle deployment with commands but because we've got many methods there would have to be an intelligent way of handling that.
### Plugin Constraints