readme.md
1# app-builder
2
3Generic helper tool to build app in a distributable formats.
4Used by [electron-builder](http://github.com/electron-userland/electron-builder) but applicable not only for building Electron applications.
5
6```
7usage: app-builder [<flags>] <command> [<args> ...]
8
9app-builder
10
11Flags:
12 --help Show context-sensitive help (also try --help-long and --help-man).
13 --version Show application version.
14
15Commands:
16 help [<command>...]
17 Show help.
18
19
20 blockmap --input=INPUT [<flags>]
21 Generates file block map for differential update using content defined
22 chunking (that is robust to insertions, deletions, and changes to input
23 file)
24
25 -i, --input=INPUT input file
26 -o, --output=OUTPUT output file
27 -c, --compression=gzip compression, one of: gzip, deflate
28
29 download --url=URL --output=OUTPUT [<flags>]
30 Download file.
31
32 -u, --url=URL The URL.
33 -o, --output=OUTPUT The output file.
34 --sha512=SHA512 The expected sha512 of file.
35
36 download-artifact --name=NAME --url=URL [<flags>]
37 Download, unpack and cache artifact from GitHub.
38
39 -n, --name=NAME The artifact name.
40 -u, --url=URL The artifact URL.
41 --sha512=SHA512 The expected sha512 of file.
42
43 copy --from=FROM --to=TO [<flags>]
44 Copy file or dir.
45
46 -f, --from=FROM
47 -t, --to=TO
48 --hard-link Whether to use hard-links if possible
49
50 appimage --app=APP --stage=STAGE --output=OUTPUT [<flags>]
51 Build AppImage.
52
53 -a, --app=APP The app dir.
54 -s, --stage=STAGE The stage dir.
55 -o, --output=OUTPUT The output file.
56 --arch=x64 The arch.
57 --compression=COMPRESSION The compression.
58 --remove-stage Whether to remove stage after build.
59
60 snap --app=APP --stage=STAGE --output=OUTPUT [<flags>]
61 Build snap.
62
63 -t, --template=TEMPLATE The template file.
64 -u, --template-url=TEMPLATE-URL
65 The template archive URL.
66 --template-sha512=TEMPLATE-SHA512
67 The expected sha512 of template archive.
68 -a, --app=APP The app dir.
69 -s, --stage=STAGE The stage dir.
70 --icon=ICON The path to the icon.
71 --hooks=HOOKS The hooks dir.
72 --arch=amd64 The arch.
73 -o, --output=OUTPUT The output file.
74 --docker-image="snapcore/snapcraft:latest"
75 The docker image.
76 --docker Whether to use Docker.
77 --remove-stage Whether to remove stage after build.
78
79 icon --input=INPUT --format=FORMAT --out=OUT [<flags>]
80 create ICNS or ICO or icon set from PNG files
81
82 -i, --input=INPUT ... input directory or file
83 -f, --format=FORMAT output format
84 --out=OUT output directory
85 -r, --root=ROOT ... base directory to resolve relative path
86
87 dmg --volume=VOLUME [<flags>]
88 Build dmg.
89
90 --volume=VOLUME
91 --icon=ICON
92 --background=BACKGROUND
93```