Skip to content

Commit ff84187

Browse files
committed
cli: change formawt
1 parent 6414ea1 commit ff84187

File tree

5 files changed

+59
-72
lines changed

5 files changed

+59
-72
lines changed

docs/API/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Scratch itself provides a number of urls which can be used for interaction via w
77

88
!!! info
99

10-
It is recommended to use an [existing library](existing-libraries) to interact with scratch instead of making your own
10+
It is recommended to use an [existing library](existing-libraries.md) to interact with scratch instead of making your own
1111

1212
## Web API
1313

docs/CLI/accs.md

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

docs/CLI/groups.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Groups
2+
3+
Groups are one of the special features of the scratch CLI. They allow for the grouping of sessions to be able to mass-perform actions.
4+
5+
---
6+
7+
`sc group new [NAME]`
8+
9+
Create a new group. A prompt will ask for any accounts to add, delimited by spaces.
10+
11+
---
12+
13+
`sc group switch [NAME]`
14+
15+
You can switch to a group using `sc group switch`.
16+
17+
---
18+
19+
`sc group add`
20+
21+
Add sessions to the group. A prompt will ask for any accounts to add, delimited by spaces. Any duplicates will be ignored
22+
23+
---
24+
25+
`sc group remove`
26+
27+
Remove members of the group. A prompt will ask for which indexes to remove.
28+
29+
---
30+
31+
`sc group rename`
32+
33+
Rename the group, if possible

docs/CLI/index.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,18 @@ Scratch CLI is built to be good for account management. It makes it easy to:
1515
- Perform actions with multiple accounts
1616
- Manage certain groups of accounts
1717

18-
For more info, go [here](./accs.md)
18+
For more info about multi account management, go [here](sessions.md)
19+
20+
It's recommended to add an alias `sc` to Scratch CLI as will be used in this documentation.
21+
On linux, you can do this using `.bashrc`.
22+
23+
## Implementation details
24+
25+
- The CLI will use `sqlite` (subject to change?)
26+
27+
## Scratchattach objects
28+
29+
format: `-{object-type} {identifying info} ({other info})`
30+
- Users: `-U {username}`
31+
- Projects `-P {id} (name)`
32+
- Studios `-S {id} (name)`

docs/CLI/sessions.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Sessions
2+
3+
`sc login` | `sc login --id`
4+
5+
In the scratch CLI, an account can be added by session ID, ot by username/password.
6+
This will be registered as a session within the database. If the registered username already exists, it will be updated.
7+
8+
It will also create a new group with the username, if possible.
9+
There will then be an option `(Y/n)` to add the session to the current group.
10+
You can read more about groups [here](groups.md)

0 commit comments

Comments
 (0)