CLICommands
geo
snug geo <COMMAND>Geo-proximity operations.
Subcommands
| Command | What it does |
|---|---|
create | Create a new geo index |
list | List geo indexes |
get | Get geo index details |
update | Update a geo index |
delete-index | Delete a geo index |
update-location | Update entity location |
query-radius | Query entities within radius |
query-bbox | Query entities within bounding box |
delete-entity | Delete entity from index |
stats | Get index statistics |
batch-update-location | Batch update entity locations from a JSON file |
list-entities | List entities currently stored in an index |
get-entity | Get a single entity's current position |
distance | Compute the distance between two entities |
create-fence | Create a geofence within an index |
list-fences | List geofences within an index |
get-fence | Get geofence details |
update-fence | Update a geofence |
delete-fence | Delete a geofence |
check-fence | Check whether a point is inside a geofence |
Run snug geo <command> --help for that command's own options.
The global options apply everywhere.
Examples
snug geo create --name fleet --description 'Fleet tracking index'
snug geo list
snug geo get --id idx_abc123
snug geo update --id idx_abc123 --name 'Updated Fleet'
snug geo delete-index --id idx_abc123 --force
snug geo update-location --id idx_abc123 -e truck123 -x -73.987 -y 40.748
snug geo batch-update-location --id idx_abc123 --file positions.json
snug geo list-entities --id idx_abc123
snug geo get-entity --id idx_abc123 -e truck123
snug geo query-radius --id idx_abc123 -x -73.987 -y 40.748 -r 1000 -d -c
snug geo query-bbox --id idx_abc123 --min-lon -74.0 --min-lat 40.7 --max-lon -73.9 --max-lat 40.8
snug geo distance --id idx_abc123 --from truck123 --to truck456 -u km
snug geo delete-entity --id idx_abc123 -e truck123
snug geo stats --id idx_abc123
snug geo create-fence --id idx_abc123 --name downtown --shape circle -x -73.987 -y 40.748 -r 500
snug geo list-fences --id idx_abc123
snug geo get-fence --id idx_abc123 --fence-id fnc_abc
snug geo update-fence --id idx_abc123 --fence-id fnc_abc -r 1000
snug geo check-fence --id idx_abc123 --fence-id fnc_abc -x -73.987 -y 40.748
snug geo delete-fence --id idx_abc123 --fence-id fnc_abc --forceNext
- geo guide - what the service does and when to reach for it.
- API reference - every endpoint these commands call.
- CLI reference - global options, output modes, and exit codes.