app_list | List all available web applications.
Returns:
A dictionary containing the list of available apps and their details |
app_delete | Delete an existing web application.
Args:
app_name: Name of the application to delete
Returns:
A dictionary containing the result of the operation |
app_create | Create a new web application directory and copy starter files.
The starter files are for you to replace with actual content, you don't have to use them as is.
the goose_api.js file is a utility you will want to keep in case you need to do api calls as part of your app via goose.
Args:
app_name: Name of the application (will be used as directory name)
description: Brief description of the application (default: "")
Returns:
A dictionary containing the result of the operation
After this, consider how you want to change the app to meet the functionality, look at the examples in resources dir if you like.
Or, you can replace the content with existing html/css/js files you have (just make sure to leave the goose_api.js file in the app dir)
Use the app_error tool once it is opened and user has interacted (or has started) to check for errors you can correct the first time, this is important to know it works. |
app_serve | Serve an existing web application on a local HTTP server.
The server will automatically find an available port.
Can only serve one app at a time
Args:
app_name: Name of the application to serve
Returns:
A dictionary containing the result of the operation |
app_stop_server | Stop the currently running HTTP server.
Returns:
A dictionary containing the result of the operation |
app_open | Open an app in the default web browser. If the app is not currently being served,
it will be served first.
Can only open one app at a time.
Args:
app_name: Name of the application to open
Returns:
A dictionary containing the result of the operation |
app_refresh | Refresh the currently open app in Chrome.
Only works on macOS with Google Chrome.
Returns:
A dictionary containing the result of the operation |
app_response | Use this to return a response to the app that has been requested.
Provide only one of string_data, list_data, or table_data.
Args:
string_data: Optional string response
list_data: Optional list of strings response
table_data: Optional table response with columns and rows
Format: {"columns": ["col1", "col2", ...], "rows": [["row1col1", "row1col2", ...], ...]}
Returns:
True if the response was stored successfully, False otherwise |
app_error | Report an error from the app or retrieve the list of errors.
This is useful while developing or debugging the app as it allows errors (or any messages) to be reported and monitored
Args:
error_message: Optional error message to report. If None, returns the list of errors.
clear: Optional, If True, clears the list of errors
Returns:
A string containing the list of errors if error_message is None,
otherwise a confirmation message. |