Skip to content

Commit 323aa3e

Browse files
committed
chore: remove unused sftp-template.json file and update CLI documentation for developer mode features
1 parent 77f51ba commit 323aa3e

File tree

3 files changed

+17
-26
lines changed

3 files changed

+17
-26
lines changed

.vscode/sftp-template.json

Lines changed: 0 additions & 22 deletions
This file was deleted.

api/docs/public/cli.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,17 @@ Switch between production and staging environments.
6262
### Developer Mode
6363

6464
```bash
65-
unraid-api developer
65+
unraid-api developer # Interactive prompt for tools
66+
unraid-api developer --sandbox true # Enable GraphQL sandbox
67+
unraid-api developer --sandbox false # Disable GraphQL sandbox
68+
unraid-api developer --enable-modal # Enable modal testing tool
69+
unraid-api developer --disable-modal # Disable modal testing tool
6670
```
6771

68-
Configure developer features for the API (e.g., GraphQL sandbox).
72+
Configure developer features for the API:
73+
74+
- **GraphQL Sandbox**: Enable/disable Apollo GraphQL sandbox at `/graphql`
75+
- **Modal Testing Tool**: Enable/disable UI modal testing in the Unraid menu
6976

7077
## API Key Management
7178

api/docs/public/how-to-use-the-api.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,19 @@ The Unraid API provides a GraphQL interface that allows you to interact with you
44

55
## Enabling the GraphQL Sandbox
66

7-
1. First, enable developer mode using the CLI:
7+
1. Enable developer mode using the CLI:
88

9+
```bash
10+
unraid-api developer --sandbox true
11+
```
12+
13+
Or use the interactive mode:
14+
915
```bash
1016
unraid-api developer
1117
```
1218

13-
2. Follow the prompts to enable the sandbox. This will allow you to access the Apollo Sandbox interface.
19+
2. Once enabled, you can access the Apollo Sandbox interface
1420

1521
3. Access the GraphQL playground by navigating to:
1622

0 commit comments

Comments
 (0)