Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 970 Bytes

README.md

File metadata and controls

42 lines (28 loc) · 970 Bytes
Raw

Yargs example

How to expose the Surge CLI within your own command line tool, built with Yargs.

Getting started

This example command line tool will show you how to build Surge into your own CLI, using Yargs. The code is commented, and shows some basic pre- and post-run hooks you can add between Surge’s steps.

You can run the binary to test this module locally with:

node ./bin/example

Try running example publish to see the hooks in action:

node ./bin/example publish

Hooks

Here are all the pre- and post-run hooks available:

  • hooks.preAuth
  • hooks.postAuth
  • hooks.preProject
  • hooks.postProject
  • hooks.preSize
  • hooks.postSize
  • hooks.preDomain
  • hooks.postDomain
  • hooks.prePublish
  • hooks.postPublish

License

The MIT License (MIT)

Copyright © 2015 Chloi Inc.