1
1
Usage:
2
2
3
3
$ curl localhost:8000 # current location
4
- $ curl localhost:8000?args= loc=new_york # surf report in New new_york
4
+ $ curl localhost:8000?loc=new_york # surf report in New York
5
5
6
6
Supported location types:
7
7
@@ -18,26 +18,34 @@ Units:
18
18
19
19
Arguments:
20
20
21
- location / loc #Specify the location of your forecast
22
- forecast / fc # Number of forecast days. Max = 7, default = 0
23
- hide_wave / hw # Hide the default wave art
24
- show_large_wave / slw # Show the large wave art
25
- hide_uv / huv # Hide uv index
26
- hide_height / hh # Hide surf height
27
- hide_direction / hdir # Hide Swell direction
28
- hide_period / hp # Hide swell period
29
- hide_location / hl # Hide location
30
- hide_date / hdate # Hide date in forecast
31
- metric / m # Numbers in Metric units. Defaults to Imperial
32
- decimal / dec # Specify decimal points in output
33
- color / c # Choose color of wave art. Ex: color=light_blue
21
+ location / loc # Specify the location of your forecast
22
+ forecast / fc # Number of forecast days. Max = 7, default = 0
23
+ hide_wave / hw # Hide the default wave art
24
+ show_large_wave / slw # Show the large wave art
25
+ show_air_temp / sat # Show the air temperature
26
+ show_wind_speed / sws # Show the wind speed
27
+ show_wind_direction / swd # Show the wind direction
28
+ hide_uv / huv # Hide UV index
29
+ hide_height / hh # Hide surf height
30
+ hide_direction / hdir # Hide swell direction
31
+ hide_period / hp # Hide swell period
32
+ hide_location / hl # Hide location
33
+ hide_date / hdate # Hide date in forecast
34
+ metric / m # Numbers in Metric units. Defaults to Imperial
35
+ decimal / dec # Specify decimal points in output
36
+ color / c # Choose color of wave art. Ex: color=light_blue
37
+ json / j # Output the data in JSON format. Must be the only argument
38
+ gpt / g # Activates the GPT surf report. Change the GPT_PROMPT variable in .env to customize responses. Default = off
34
39
35
40
Color Options:
36
41
37
- defualt , red, green, yellow, blue, purple, teal, light_blue
42
+ default , red, green, yellow, blue, purple, teal, light_blue
38
43
39
44
Examples:
40
45
41
46
curl localhost:8000
42
- curl localhost:8000?args=location=new_york,hide_height,hide_wave,show_large_wave
43
- curl localhost:8000?args=fc=3,hdate,loc=trestles,c=light_blue
47
+ curl localhost:8000?loc=new_york,hide_height,hide_wave,show_large_wave
48
+ curl localhost:8000?fc=3,hdate,loc=trestles,c=light_blue
49
+ curl localhost:8000?loc=malibu,show_air_temp,show_wind_speed,show_wind_direction
50
+ curl localhost:8000?loc=nazare,json
51
+ curl localhost:8000?loc=gold_coast,gpt,color=yellow
0 commit comments