Command Line Interface#
Documentation#
camply#
Welcome to camply, the campsite finder.
Finding reservations at sold out campgrounds can be tough. That's where camply comes in. It searches the APIs of booking services like https://recreation.gov (which indexes thousands of campgrounds across the USA) to continuously check for cancellations and availabilities to pop up. Once a campsite becomes available, camply sends you a notification to book your spot!
visit the camply documentation at https://juftin.com/camply
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--debug / --no-debug |
boolean | Enable extra debugging output | None |
--provider |
choice (RecreationDotGov | Yellowstone | GoingToCamp | ReserveCalifornia | AlabamaStateParks | ArizonaStateParks | FloridaStateParks | MinnesotaStateParks | MissouriStateParks | OhioStateParks | VirginiaStateParks | NorthernTerritory | FairfaxCountyParks | MaricopaCountyParks | OregonMetro | RecreationDotGovTicket | RecreationDotGovTimedEntry | RecreationDotGovDailyTicket | RecreationDotGovDailyTimedEntry) |
Camping Search Provider. Defaults to 'RecreationDotGov' | None |
--version |
boolean | Show the version and exit. | False |
--help |
boolean | Show this message and exit. | False |
Subcommands
- campgrounds:
- campsites:
- configure:
- equipment-types:
- list-campsites:
- providers:
- recreation-areas:
- test-notifications:
camply campgrounds#
Search for Campgrounds (inside of Recreation Areas) and list them
Search for Campgrounds and their IDs. Campgrounds are facilities inside of Recreation Areas that contain campsites. Most 'campgrounds' are areas made up of multiple campsites, others are facilities like fire towers or cabins that might only contain a single 'campsite' to book.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--search |
text | Search for Campgrounds or Recreation Areas by search string. | None |
--state |
text | Filter by US state code. | None |
--rec-area |
text | Add Recreation Areas (comprised of campgrounds) by ID. | None |
--campground |
text | Add individual Campgrounds by ID. | None |
--campsite |
text | Add individual Campsites by ID. | None |
--provider |
choice (RecreationDotGov | Yellowstone | GoingToCamp | ReserveCalifornia | AlabamaStateParks | ArizonaStateParks | FloridaStateParks | MinnesotaStateParks | MissouriStateParks | OhioStateParks | VirginiaStateParks | NorthernTerritory | FairfaxCountyParks | MaricopaCountyParks | OregonMetro | RecreationDotGovTicket | RecreationDotGovTimedEntry | RecreationDotGovDailyTicket | RecreationDotGovDailyTimedEntry) |
Camping Search Provider. Defaults to 'RecreationDotGov' | None |
--debug / --no-debug |
boolean | Enable extra debugging output | None |
--help |
boolean | Show this message and exit. | False |
camply campsites#
Find Available Campsites with Custom Search Criteria
Search for a campsite within camply. Campsites are returned based on the search criteria
provided. Campsites contain properties like booking date, site type (tent, RV, cabin, etc),
capacity, price, and a link to make the booking. Required parameters include
--start-date, --end-date, --rec-area / --campground. Constant searching
functionality can be enabled with --continuous and notifications can be enabled using
--notifications.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--rec-area |
text | Add Recreation Areas (comprised of campgrounds) by ID. | None |
--campground |
text | Add individual Campgrounds by ID. | None |
--campsite |
text | Add individual Campsites by ID. | None |
--start-date |
text | (YYYY-MM-DD) Start of Search window. You will be arriving this day. | None |
--end-date |
text | (YYYY-MM-DD) End of Search window. You will be checking out this day. | None |
--nights |
integer | Search for campsite stays with consecutive nights. Defaults to 1 which returns all campsites found. | 1 |
--weekends |
boolean | Only search for weekend bookings (Fri/Sat nights). | False |
--day |
choice (Monday | Tuesday | Wednesday | Thursday | Friday | Saturday | Sunday | MON | TUE | TUES | WED | THU | THUR | THURS | FRI | SAT | SUN) |
Day(s) of the Week to search. | None |
--notifications |
choice (pushover | email | ntfy | apprise | pushbullet | slack | telegram | twilio | webhook | silent) |
Enables continuous searching. Types of notifications to receive. Options available are pushover, email, ntfy, apprise, pushbullet, slack, telegram, twilio, webhook, silent. Defaults to silent - which just logs messages to console. |
[] |
--continuous |
boolean | Continuously check for a campsite to become available, and quit once at least one campsite is found. | False |
--search-forever |
text | Enables continuous searching. This method continues to search after the first availability has been found. The one caveat is that it will never notify about the same identical campsite for the same booking date. | False |
--yaml-config, --yml-config |
file | Rather than provide arguments to the command line utility, instead pass a file path to a YAML configuration file. See the documentation for more information on how to structure your configuration file. | None |
--offline-search |
boolean | When set to True, the campsite search will both save the results of the campsites it's found, but also load those campsites before beginning a search for other campsites. | False |
--offline-search-path |
file | Enables offline search. This is the name of the file to be saved/loaded. Campsites can be saved as a serialized pickle file or a JSON file, depending on the file extension. When not specified, the filename will default to camply_campsites.json |
None |
--search-once |
boolean | Enables continuous searching features - but doesn't actually search continuously. This option is only useful when you want to run camply periodically in a CRON job fashion but still receive notifications - it's strongly recommended you enable offline searching as well to save results between searches. | False |
--polling-interval |
integer | Enables continuous searching. How often to wait in between checks (in minutes). Defaults to 10, cannot be less than 5. | None |
--notify-first-try |
text | Enables continuous searching. Whether to send all non-silent notifications if more than 5 matching campsites are found on the first try. Defaults to False which only sends the first 5. | False |
--equipment |
text | Search for campsites compatible with your camping equipment. This argument accepts two options, the equipment name and its length If you don't want to filter based on length provide a length of 0. Accepted equipment names include Tent, RV. Trailer, Vehicle and are not case-sensitive. |
None |
--equipment-id |
text | Search for campsites compatible with specific equipment categories. Going To Camp uses equipment category IDs for filtering campsites by equipment. Every recreation area has equipment categories unique to it. Use camply equipment-types --provider GoingToCamp --rec-area <rec area id> to get a listing of equipment for an area. |
None |
--provider |
choice (RecreationDotGov | Yellowstone | GoingToCamp | ReserveCalifornia | AlabamaStateParks | ArizonaStateParks | FloridaStateParks | MinnesotaStateParks | MissouriStateParks | OhioStateParks | VirginiaStateParks | NorthernTerritory | FairfaxCountyParks | MaricopaCountyParks | OregonMetro | RecreationDotGovTicket | RecreationDotGovTimedEntry | RecreationDotGovDailyTicket | RecreationDotGovDailyTimedEntry) |
Camping Search Provider. Defaults to 'RecreationDotGov' | None |
--debug / --no-debug |
boolean | Enable extra debugging output | None |
--help |
boolean | Show this message and exit. | False |
camply configure#
Set up camply configuration file with an interactive console
In order to send notifications through camply you must set up some authorization values. Whether you need to set up pushover notifications (push notifications on your phone, your pushover account can be set up at https://pushover.net) or Email messages, everything can be done through the configure command. The end result is a file called .camply in your home folder.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--debug / --no-debug |
boolean | Enable extra debugging output | None |
--help |
boolean | Show this message and exit. | False |
camply equipment-types#
Get a list of supported equipment
This command returns supported equipment for the current provider/recreation area. Equipment are camping equipment that can be used at a campsite. Different providers and recreation areas have different types of equipment for which reservations can be made.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--rec-area |
text | Add Recreation Areas (comprised of campgrounds) by ID. | None |
--provider |
choice (RecreationDotGov | Yellowstone | GoingToCamp | ReserveCalifornia | AlabamaStateParks | ArizonaStateParks | FloridaStateParks | MinnesotaStateParks | MissouriStateParks | OhioStateParks | VirginiaStateParks | NorthernTerritory | FairfaxCountyParks | MaricopaCountyParks | OregonMetro | RecreationDotGovTicket | RecreationDotGovTimedEntry | RecreationDotGovDailyTicket | RecreationDotGovDailyTimedEntry) |
Camping Search Provider. Defaults to 'RecreationDotGov' | None |
--help |
boolean | Show this message and exit. | False |
camply list-campsites#
List campsite IDs for a given campground or recreation area
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--rec-area |
text | Add Recreation Areas (comprised of campgrounds) by ID. | None |
--campground |
text | Add individual Campgrounds by ID. | None |
--provider |
choice (RecreationDotGov | Yellowstone | GoingToCamp | ReserveCalifornia | AlabamaStateParks | ArizonaStateParks | FloridaStateParks | MinnesotaStateParks | MissouriStateParks | OhioStateParks | VirginiaStateParks | NorthernTerritory | FairfaxCountyParks | MaricopaCountyParks | OregonMetro | RecreationDotGovTicket | RecreationDotGovTimedEntry | RecreationDotGovDailyTicket | RecreationDotGovDailyTimedEntry) |
Camping Search Provider. Defaults to 'RecreationDotGov' | None |
--debug / --no-debug |
boolean | Enable extra debugging output | None |
--help |
boolean | Show this message and exit. | False |
camply providers#
List the different camply providers
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--debug / --no-debug |
boolean | Enable extra debugging output | None |
--help |
boolean | Show this message and exit. | False |
camply recreation-areas#
Search for Recreation Areas and list them
Search for Recreation Areas and their IDs. Recreation Areas are places like National Parks and National Forests that can contain one or many campgrounds.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--search |
text | Search for Campgrounds or Recreation Areas by search string. | None |
--state |
text | Filter by US state code. | None |
--debug / --no-debug |
boolean | Enable extra debugging output | None |
--provider |
choice (RecreationDotGov | Yellowstone | GoingToCamp | ReserveCalifornia | AlabamaStateParks | ArizonaStateParks | FloridaStateParks | MinnesotaStateParks | MissouriStateParks | OhioStateParks | VirginiaStateParks | NorthernTerritory | FairfaxCountyParks | MaricopaCountyParks | OregonMetro | RecreationDotGovTicket | RecreationDotGovTimedEntry | RecreationDotGovDailyTicket | RecreationDotGovDailyTimedEntry) |
Camping Search Provider. Defaults to 'RecreationDotGov' | None |
--help |
boolean | Show this message and exit. | False |
camply test-notifications#
Test your notification provider setup
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--notifications |
choice (pushover | email | ntfy | apprise | pushbullet | slack | telegram | twilio | webhook | silent) |
Types of notifications to receive. Options available are pushover, email, ntfy, apprise, pushbullet, slack, telegram, twilio, webhook, silent. Defaults to silent - which just logs messages to console. |
_required |
--debug / --no-debug |
boolean | Enable extra debugging output | None |
--help |
boolean | Show this message and exit. | False |