Skip to content

Commit cfc5e47

Browse files
committed
docs: scratch cli basics
1 parent 5761c33 commit cfc5e47

File tree

2 files changed

+70
-0
lines changed

2 files changed

+70
-0
lines changed

docs/CLI/accs.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Accounts
2+
3+
## Sessions
4+
5+
A session represents a single 'log in' for a scratch account.
6+
7+
The session object:
8+
```json
9+
{
10+
"username": "faretek1",
11+
"id": "..."
12+
}
13+
```
14+
15+
### `scratch login`
16+
17+
Login to a scratch account and add it to the current group. You will be prompted for a username and password
18+
19+
### `scratch login --sessid`
20+
21+
Login to a scratch account and add it to the current group. You will be prompted for a session ID.
22+
23+
## Account groups
24+
25+
The CLI allows you to configure account groups. These are collections of 1+ accounts which you can perform actions with.
26+
27+
The group object:
28+
```json
29+
{
30+
"name": "FA",
31+
"sessions": [
32+
{
33+
"username": "faretek1",
34+
"id": "..."
35+
},
36+
{
37+
"username": "faretek",
38+
"id": "..."
39+
}
40+
]
41+
}
42+
```
43+
44+
These are stored in the cookies as values for an object, not a list. The key is the name but lowercase.
45+
46+
### `scratch ungroup`
47+
48+
This exits the current group and into the 'global' group. If you login now, it will make a new group with only 1 member.
49+
50+
### `scratch group`
51+
52+
Get the members of the group.

docs/CLI/index.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Scratch CLI
2+
3+
!!! Warning
4+
5+
This documentation currently does not apply. It is currently documenting a specification for the tool.
6+
7+
The [Scratch CLI](https://github.com/scratch-api/scratch-cli) is a command line client for scratch that wraps
8+
scratchattach.
9+
10+
## Why Scratch CLI?
11+
12+
Scratch CLI is built to be good for account management. It makes it easy to:
13+
14+
- Switch between accounts
15+
- Perform actions with multiple accounts
16+
- Manage certain groups of accounts
17+
18+
For more info, go [here](./accs.md)

0 commit comments

Comments
 (0)