Commands
Doks comes with commands for common tasks.
You can change the commands in the scripts section of `./package.json`.
create
Create new content for your site:
npm run create [path] [flags]
See also the Hugo docs: hugo new.
Docs based tree
Create a docs based tree — with a single command:
npm run create -- --kind docs [section]
For example, create a docs based tree named guides:
npm run create -- --kind docs guides
lint
Check scripts, styles, and markdown for errors:
npm run lint
scripts
Check scripts for errors:
npm run lint:scripts [-- --fix]
styles
Check styles for errors:
npm run lint:styles [-- --fix]
markdown
Check markdown for errors:
npm run lint:markdown [-- --fix]
clean
Delete temporary directories:
npm run clean
start
Start local development server:
npm run start
build
Build production website:
npm run build
functions
Build Lambda functions:
npm run build:functions
preview
Build production website including draft and future content:
npm run build:preview
Example Request - Auth 200
curl --location 'https://localhost:7278/api/identity/apps/v1/Auth' \
--data '{
"clientId": "roaa_osos_external_system",
"clientSecret": "EHMcQfTjWnZr4u7ADFJaNdRgUkXp2s5v8yBEHKbPeShVmYq3t6wZH3B4M9"
}'
</details>
<details>
<summary>Example Response</summary>
json
Copy code
{
"data": {
"info": {
"RoSaaSClient": {
"name": "roaa",
"title": "Roaa Tech"
},
"RoSaaSProduct": {
"name": "osos",
"title": "OSOS System"
}
},
"token": {
"accessToken": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjAwRDEzRTlBRUU0NUZBMzY3QkZBMjBDODA0OTI2RDFBIiwidHlwIjoiYXQrand0In0.eyJuYmYiOjE2OTE5MzQ1NDksImV4cCI6MTY5MTkzODE0OCwiaXNzIjoiaHR0cDovL2Rldi5yb3Nhcy5yb2FhLnRlY2giLCJqdGkiOiI5QzI3QzMxQ0Q0Nzc0NkI5OEUzQTZGMzUzRUEzODhFMSIsImlhdCI6IjE2OTE5MzQ1NDkiLCJjbGllbnRfaWQiOiJyb2FhX29zb3NfZXh0ZXJuYWxfc3lzdGVtIiwicGlkIjoiODhlNjczMjgtM2IyMC00MTNlLWI2ZTEtMDEwYjQ4ZmE3YmM5IiwiYW10aCI6ImNsaWVudF9jcmVkZW50aWFscyIsInR5cGUiOiJleHRlcm5hbF9zeXN0ZW0iLCJhdWQiOiJyb3Nhc19hcGlfcmVzb3VyY2UiLCJzY29wZSI6WyJleHRlcm5hbF9zeXN0ZW1fc2NvcGUiXX0.PLHEXXs1t_VbfAc9ykGwAXDnBpN59ekKkKMhxQFfjsTKVfieclSBbohJ1ZFsli8qt48Bdbhxuf6fpf3ghOEkCPOzqsDmCMz9FF_IowGeWo65UP5KiQCpC1-3qai6uw1W5NirEPmRieslYVLpyL4wzighBF6BT3Z58XGlio99vP83d5qt-KvxJTq_RXUIx70SwhTr6MQ7YJ1vKzAqVD8aj4bNEjvAu54P2VQLYqczvg8IzwDnELec7ZCKd4zeGrbxEeQn6gA4qiYE_9qqbVXzmvBPJuH8fvgs5_PSFp4jfQeHp8d1Oy09YvdIaNbLqn4XrkD7l8e9r_VlfCzGECXIvQ"
}
},
"metadata": {
"errors": [],
"success": true
}
}
</details>