{"id":19850211,"url":"https://github.com/trailbehind/tile-squirrel","last_synced_at":"2025-05-01T22:30:56.690Z","repository":{"id":36691761,"uuid":"40998258","full_name":"trailbehind/tile-squirrel","owner":"trailbehind","description":"Tile Squirrel renders map tiles in bulk across multiple hosts using a queue","archived":false,"fork":false,"pushed_at":"2023-03-04T14:54:17.000Z","size":79,"stargazers_count":10,"open_issues_count":3,"forks_count":0,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-04-26T23:36:14.292Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/trailbehind.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-08-18T21:24:13.000Z","updated_at":"2023-12-15T22:02:29.000Z","dependencies_parsed_at":"2022-09-25T02:01:39.632Z","dependency_job_id":null,"html_url":"https://github.com/trailbehind/tile-squirrel","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trailbehind%2Ftile-squirrel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trailbehind%2Ftile-squirrel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trailbehind%2Ftile-squirrel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/trailbehind%2Ftile-squirrel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/trailbehind","download_url":"https://codeload.github.com/trailbehind/tile-squirrel/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251954830,"owners_count":21670887,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T13:24:47.377Z","updated_at":"2025-05-01T22:30:56.372Z","avatar_url":"https://github.com/trailbehind.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tile Squirrel\nTile Squirrel is designed to render map tiles in bulk across multiple hosts. Tiles are added to a queue, and then one or more workers can read from the queue and render tiles. RabbitMQ is used for queuing, and tilelive is used for sources and destinations for tiles.\n\n## Commands\n\n### squirrel.js\nThis is the tiling worker. It reads from the queue and makes tiles.\n\n```\nUsage: node squirrel.js [options]\n\nOptions:\n   -c CONFIG, --config CONFIG    Provide a configuration file\n   -r MODULE, --require MODULE   Require a specific tilelive module\n   -v, --version                 Show version info\n\nA configuration file is required.\n```\n\n### add-bbox.js\nAdd all tiles in a bounding box to the queue. Can work on one or more sources at a time. Tiles are split into groups for queuing. \n\n```\nUsage: node add-bbox.js [sources]... [options]\n\nsources     source names to queue\n\nOptions:\n   -c CONFIG, --config CONFIG   Provide a configuration file. Configuration file is not needed, but if it is provided sources will be verified to exist in config.\n   -z ZOOM, --zoom ZOOM         zoom, can be a single number or a range like 5-10\n   -b BBOX, --bbox BBOX         BBOX in W,S,E,N format  [-180,-85.0511287798066,180,85.0511287798066]\n   --xSize size                 Max x size of chunks.  [8]\n   --ySize size                 Max y size of chunks.  [8]\n   -v, --version                Show version info\n\nA zoom, or range of zooms, and one or more sources is required.\n```\n\n### add-tile-list.js\nAdd a list of tiles to the queue. Defaults to reading from STDIN, but can also read from a file.\n\n```\nUsage: node add-tile-list.js [sources]... [options]\n\nsources     source names to queue\n\nOptions:\n   -d, --dryRun    Dry run. Don't actually add messages to queue.\n   -v, --version   Show version info\n\nRead a list of tiles to queue for rendering.\n```\n\n### add-tile.js\nAdd a single tile to the queue.\n\n```\nUsage: node add-tile.js [source] [tile] [options]\n\nsource     Source to queue\ntile       Tile to queue\n\nOptions:\n   -c CONFIG, --config CONFIG   Provide a configuration file. Configuration file is not needed, but if it is provided sources will be verified to exist in config.\n   -v, --version                Show version info\n\nQueue a single tile\n```\n\n### copy-info.js\nCopy metadata from a source to a sink\n\n```\nUsage: node copy-info.js [sources]... [options]\n\nsources     source names to queue\n\nOptions:\n   -c CONFIG, --config CONFIG   Configuration file.\n   -v, --version                Show version info\n\nCopy metadata from a source to a sink.\n```\n\n## Configuration\n\n### Configuration File\nThe configuration file defines a tilesets, each with a source and a sink.\n\n```\n{\n  \"topo\": {\n    \"source\": \"tmsource:///Users/jesse/projects/topo.tm2source\",\n    \"destination\": \"file:///Users/jesse/working-data/squirrel-tiles?filetype=pbf\"\n  },\n  \"osm\":{\n    \"source\":\"tmsource:///Users/jesse/projects/osm.tm2source\",\n    \"destination\":\"s3simple://vector-tiles-testing.gaiagps.com/osm/?filetype=pbf\"\n  }\n}\n```\n\nThe configuration file aims to be compatible with [Tessera](https://github.com/mojodna/tessera).\n\n### Environment variables\n* `AMPQ_HOST` - RabbitMQ host to connect to. Defaults to `localhost`.\n* `AMPQ_TOPIC` - RabbitMQ topic to use. Defaults to `tiles`.\n* `UV_THREADPOOL_SIZE` - Threadpool size to use. defaults to `4`\n* `TILESQUIRREL_OPTS` - Additional command line arguments.\n* `WORKER_COUNT` = Number of worker threads to start. Defaults to the number of cpu cores.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrailbehind%2Ftile-squirrel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftrailbehind%2Ftile-squirrel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrailbehind%2Ftile-squirrel/lists"}