Skip to content

Commit 512adf0

Browse files
bdonbdon
authored
Clean up formatting of CLI; hide unimplemented subcommands (#205)
* Clean up formatting of CLI; hide unimplemented subcommands * edit copy updates
1 parent b2c24da commit 512adf0

File tree

1 file changed

+50
-50
lines changed

1 file changed

+50
-50
lines changed

‎main.go

+50-50
Original file line numberDiff line numberDiff line change
@@ -27,96 +27,96 @@ var (
2727
)
2828

2929
var cli struct {
30-
Convert struct {
31-
Input string `arg:"" help:"Input archive." type:"existingfile"`
32-
Output string `arg:"" help:"Output PMTiles archive." type:"path"`
33-
Force bool `help:"Force removal."`
34-
NoDeduplication bool `help:"Don't attempt to deduplicate tiles."`
35-
Tmpdir string `help:"An optional path to a folder for temporary files." type:"existingdir"`
36-
} `cmd:"" help:"Convert an MBTiles or older spec version to PMTiles."`
37-
3830
Show struct {
3931
Path string `arg:""`
4032
Bucket string `help:"Remote bucket"`
41-
Metadata bool `help:"Print only the JSON metadata."`
42-
HeaderJson bool `help:"Print a JSON representation of the header information."`
43-
Tilejson bool `help:"Print the TileJSON."`
33+
Metadata bool `help:"Print only the JSON metadata"`
34+
HeaderJson bool `help:"Print a JSON representation of part of the header information"`
35+
Tilejson bool `help:"Print the TileJSON"`
4436
PublicURL string `help:"Public base URL of tile endpoint for TileJSON e.g. https://example.com/tiles"`
45-
} `cmd:"" help:"Inspect a local or remote archive."`
37+
} `cmd:"" help:"Inspect a local or remote archive"`
4638

4739
Tile struct {
4840
Path string `arg:""`
4941
Z int `arg:""`
5042
X int `arg:""`
5143
Y int `arg:""`
5244
Bucket string `help:"Remote bucket"`
53-
} `cmd:"" help:"Fetch one tile from a local or remote archive and output on stdout."`
45+
} `cmd:"" help:"Fetch one tile from a local or remote archive and output on stdout"`
46+
47+
Cluster struct {
48+
Input string `arg:"" help:"Input archive" type:"existingfile"`
49+
} `cmd:"" help:"Cluster an unclustered local archive" hidden:""`
5450

5551
Edit struct {
56-
Input string `arg:"" help:"Input archive file." type:"existingfile"`
57-
HeaderJson string `help:"Input header JSON file (written by show --header-json)." type:"existingfile"`
58-
Metadata string `help:"Input metadata JSON (written by show --metadata)." type:"existingfile"`
59-
} `cmd:"" help:"Edit JSON metadata or parts of the header in-place." hidden:""`
52+
Input string `arg:"" help:"Input archive" type:"existingfile"`
53+
HeaderJson string `help:"Input header JSON file (written by show --header-json)" type:"existingfile"`
54+
Metadata string `help:"Input metadata JSON (written by show --metadata)" type:"existingfile"`
55+
} `cmd:"" help:"Edit JSON metadata or parts of the header"`
6056

6157
Extract struct {
62-
Input string `arg:"" help:"Input local or remote archive."`
63-
Output string `arg:"" help:"Output archive." type:"path"`
64-
Bucket string `help:"Remote bucket of input archive."`
65-
Region string `help:"local GeoJSON Polygon or MultiPolygon file for area of interest." type:"existingfile"`
58+
Input string `arg:"" help:"Input local or remote archive"`
59+
Output string `arg:"" help:"Output archive" type:"path"`
60+
Bucket string `help:"Remote bucket of input archive"`
61+
Region string `help:"local GeoJSON Polygon or MultiPolygon file for area of interest" type:"existingfile"`
6662
Bbox string `help:"bbox area of interest: min_lon,min_lat,max_lon,max_lat" type:"string"`
67-
Minzoom int8 `default:"-1" help:"Minimum zoom level, inclusive."`
68-
Maxzoom int8 `default:"-1" help:"Maximum zoom level, inclusive."`
69-
DownloadThreads int `default:"4" help:"Number of download threads."`
70-
DryRun bool `help:"Calculate tiles to extract, but don't download them."`
63+
Minzoom int8 `default:"-1" help:"Minimum zoom level, inclusive"`
64+
Maxzoom int8 `default:"-1" help:"Maximum zoom level, inclusive"`
65+
DownloadThreads int `default:"4" help:"Number of download threads"`
66+
DryRun bool `help:"Calculate tiles to extract, but don't download them"`
7167
Overfetch float32 `default:"0.05" help:"What ratio of extra data to download to minimize # requests; 0.2 is 20%"`
72-
} `cmd:"" help:"Create an archive from a larger archive for a subset of zoom levels or geographic region."`
68+
} `cmd:"" help:"Create an archive from a larger archive for a subset of zoom levels or geographic region"`
69+
70+
Merge struct {
71+
Output string `arg:"" help:"Output archive" type:"path"`
72+
Input []string `arg:"" help:"Input archives"`
73+
} `cmd:"" help:"Merge multiple archives into a single archive"`
74+
75+
Convert struct {
76+
Input string `arg:"" help:"Input archive" type:"existingfile"`
77+
Output string `arg:"" help:"Output archive" type:"path"`
78+
Force bool `help:"Force removal"`
79+
NoDeduplication bool `help:"Don't attempt to deduplicate tiles"`
80+
Tmpdir string `help:"An optional path to a folder for temporary files" type:"existingdir"`
81+
} `cmd:"" help:"Convert an MBTiles or older spec version to PMTiles"`
7382

7483
Verify struct {
75-
Input string `arg:"" help:"Input archive." type:"existingfile"`
76-
} `cmd:"" help:"Verify the correctness of an archive structure, without verifying individual tile contents."`
84+
Input string `arg:"" help:"Input archive" type:"existingfile"`
85+
} `cmd:"" help:"Verify the correctness of an archive structure, without verifying individual tile contents"`
7786

7887
Makesync struct {
7988
Input string `arg:"" type:"existingfile"`
80-
BlockSizeKb int `default:"20" help:"The approximate block size, in kilobytes. 0 means 1 tile = 1 block."`
81-
HashFunction string `default:"xxh64" help:"The hash function."`
82-
Checksum string `help:"Store a checksum in the syncfile."`
83-
} `cmd:"" hidden:""`
89+
BlockSizeKb int `default:"20" help:"The approximate block size, in kilobytes; 0 means 1 tile = 1 block"`
90+
HashFunction string `default:"xxh64" help:"The hash function"`
91+
Checksum string `help:"Store a checksum in the syncfile"`
92+
} `cmd:"" help:"" hidden:""`
8493

8594
Sync struct {
8695
Existing string `arg:"" type:"existingfile"`
87-
New string `arg:"" help:"Local or remote archive, with .sync sidecar file."`
88-
DryRun bool `help:"Calculate new parts to download, but don't download them."`
89-
} `cmd:"" hidden:""`
96+
New string `arg:"" help:"Remote archive"`
97+
DryRun bool `help:"Calculate new parts to download, but don't download them"`
98+
} `cmd:"" help:"" hidden:""`
9099

91100
Serve struct {
92101
Path string `arg:"" help:"Local path or bucket prefix"`
93102
Interface string `default:"0.0.0.0"`
94103
Port int `default:"8080"`
95104
AdminPort int `default:"-1"`
96-
Cors string `help:"Comma-separated list of of allowed HTTP CORS origins."`
97-
CacheSize int `default:"64" help:"Size of cache in Megabytes."`
105+
Cors string `help:"Comma-separated list of of allowed HTTP CORS origins"`
106+
CacheSize int `default:"64" help:"Size of cache in megabytes"`
98107
Bucket string `help:"Remote bucket"`
99108
PublicURL string `help:"Public base URL of tile endpoint for TileJSON e.g. https://example.com/tiles/"`
100-
} `cmd:"" help:"Run an HTTP proxy server for Z/X/Y tiles."`
101-
102-
Download struct {
103-
OldFile string `type:"existingfile" help:"The old archive on disk. Providing this will check the new archive for a .sync file"`
104-
NewFile string `arg:"The remote file."`
105-
Bucket string `required:"" help:"Bucket of file to download."`
106-
DownloadThreads int `default:"4" help:"Number of download threads."`
107-
DryRun bool `help:"Calculate new parts to download, but don't download them."`
108-
Overfetch float32 `default:"0.05" help:"What ratio of extra data to download to minimize # requests; 0.2 is 20%"`
109-
} `cmd:"" help:"Download a local archive to remote storage." hidden:""`
109+
} `cmd:"" help:"Run an HTTP proxy server for Z/X/Y tiles"`
110110

111111
Upload struct {
112112
InputPmtiles string `arg:"" type:"existingfile" help:"The local PMTiles file"`
113113
RemotePmtiles string `arg:"" help:"The name for the remote PMTiles source"`
114114
MaxConcurrency int `default:"2" help:"# of upload threads"`
115-
Bucket string `required:"" help:"Bucket to upload to."`
116-
} `cmd:"" help:"Upload a local archive to remote storage."`
115+
Bucket string `required:"" help:"Bucket to upload to"`
116+
} `cmd:"" help:"Upload a local archive to remote storage"`
117117

118118
Version struct {
119-
} `cmd:"" help:"Show the program version."`
119+
} `cmd:"" help:"Show the program version"`
120120
}
121121

122122
func main() {

0 commit comments

Comments
 (0)