Skip to content
Er Galvão Abbott edited this page Sep 22, 2024 · 6 revisions

Welcome to shelly's wiki!

Configuration

Key Meaning Type Recommended Value
API.method HTTP method to be used on requests string Anything other than "GET"
API.proto HTTP protocol string "https"
API.protoSeparator Separator between protocol and the rest string "://"
API.address API address string -
API.port HTTP Server port null|number -
API.urlSeparator Separator between URL segments string "/"
API.endpoint General endpoint for processing input string -
API.CORS If the requests should be done with CORS bool -
debug If you wish to see the server response in the console bool false for Production
MOTD Message Of The Day string -
history.maxLength Maximum number of entries in the history number -
history.useLocalStorage If history should be persisted on local storage bool -
history.storeDuplicates If commands that are issued repeatedely should be stored bool false
user.name "username" to be displayed on the prompt string -
user.qualifier User's qualifier to be displayed on the prompt string "$"

Shelly's DOM specification

DomSpec

Shelly uses only 6 HTML elements, with four types: div, input, pre and span. This diagram should give you enough information to manipulate and/or add styles to shelly's elements to your heart's content.

Shelly's history feature analysis

historyLogicScreenshot

Working on the history feature was a true delight. It didn't required me to tabulate all the tests, but if you're interested you can find the spreadhseet here, in the documentation folder.