コマンドラインインターフェース

Help

$ charites help
Usage: charites [options] [command]

Options:
-v, --version                           output the version number
-h, --help                              display help for command

Commands:
init [options] <file>                   initialize a style YAML
convert <source> [destination]          convert the style JSON to YAML
build [options] <source> [destination]  build a style JSON from the YAML
serve [options] <source>                serve your map locally
help [command]                          display help for command

Checking version

$ charites --version
0.3.0

style.yml を初期化する

$ charites init -h
Usage: charites init [options] <file>

initialize a style YAML

Options:
-t, --tilejson-urls <tilejson_urls>          an URL for TileJSON. It will create empty layers from vector_layers property of TileJSON. Please use
                                            comma (,) in case multiple TileJSONs require.
-m, --metadatajson-urls <metadatajson_urls>  an URL for metadata.json. It will create empty layers from vector_layers property of metadata.json.
                                            Please use comma (,) in case multiple metadata.json require.
-c, --composite-layers                       If it is true, a single YAML will be generated with multiple layers. Default is false.
-h, --help                                   display help for command

既存の style.json を変換する

$ charites convert -h
Usage: charites convert [options] <source> [destination]

convert the style JSON to YAML

Options:
-h, --help  display help for command

style.yml から style.json にビルドする

charites build -h
Usage: charites build [options] <source> [destination]

build a style JSON from the YAML

Options:
-c, --compact-output                           build a minified style JSON
-w, --watch                                    watch YAML and build when changed
-u, --sprite-url [<sprite url>]                url to set as the sprite in style.json
-i, --sprite-input [<icon input directory>]    directory path of icon source to build icons. The default <icon source> is `icons/`
-o, --sprite-output [<icon output directory>]  directory path to output icon files. The default <icons destination> is the current directory
--provider [provider]                          your map service. e.g. `mapbox`, `geolonia`
-h, --help                                     display help for command

mapbox v2を使用している場合、デフォルトの設定ではなく、--provider mapbox を使用してmapboxサービスを指定してください。詳しくは serve コマンドセクションの --provider オプションを参照してください。

ブラウザでのリアルタイムエディタ

charites serve -h
Usage: charites serve [options] <source>

serve your map locally

Options:
--provider [provider]                        your map service. e.g. `mapbox`, `geolonia`
--mapbox-access-token [mapboxAccessToken]    Access Token for the Mapbox
-i, --sprite-input [<icon input directory>]  directory path of icon source to build icons. The default <icon
                                             source> is `icons/`
--port [port]                                Specify custom port
-h, --help                                   display help for command

Charites は serve コマンドに 3 つのオプションを用意しています。

--provider - mapbox, geolonia,又は default. 指定されない場合、デフォルト値又はコンフィグファイルに指定された値が使われます。
- mapbox - Mapbox GL JS v2.x 互換の仕様に対して実行されるフォーマットリンターです。
- geolonia と default - MapLibre GL JS 互換の仕様に対して実行されるフォーマットリンターです。
--mapbox-access-token -　マップボックスでスタイリングをする際には、アクセストークンを指定します。
--sprite-input - If you are building icon spritesheets with Charites, you can specify the directory of SVG files to compile here. See the build command for more information.
--port - Set http server's port number. When not specified, the default is 8080.