finalizer
v0.2.5
Published
CLI client for Finalizer Server. Prepares and downloads npm builds without stressing your site.
Downloads
18
Readme
Finalizer
CLI client for Finalizer Server. Prepares and downloads npm builds without stressing your site. This project is still under development. Things will break.
Installation
After setting up your npm build server with Finalizer Server. Install this CLI client globally
npm install -g finalizer
Configuration
Make sure that you have a finalizer.json
file on the root of your project (the same location as the package.json
) that specifies the url on which the build server can be accessed.
{
"baseUrl": "http://finalizer.myurl.com"
}
Creating a project
This command will create (or link) the current project to the build server. This should be done only once. Once the project is created it will trigger the first build on the server.
<name>
Project name. The name used here will be stored on the server for later access.
finalizer create <name>
Download latest build
This will download the latest npm dependencies from the build server. The project must exist already on the build server, created with the create
command.
finalizer download <name>
This command will:
- Download the dependencies in a compressed
.tar
file. - Extract them and run
npm rebuild
to relink these dependencies.
Build project
This command will trigger a new build on the build server. The project must exist already on the build server, created with the create
command.
finalizer build <name>
If the package.json
has not changed since the last build, the build will not be created. This will prevent the creation of innecesary builds on the server.
Initialize project
This command will create a basic finalizer.json
file with default settings on the project directory.
finalizer init
Check connection to build server
This will make a basic http request to the build server to make sure that a connection to it is correctly established.
finalizer check
Development
After cloning your repo
git clone [email protected]:yourusername/finalizer.git && cd finalizer
Install your dependencies with npm
npm install
Tests are written with Mocha
and expect.js
, run the test suite with:
npm test
License
MIT