Skip to content

Commit 8a42889

Browse files
committed
cli: add docs for some commands
1 parent 4e466bf commit 8a42889

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

docs/CLI/index.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ On linux, you can do this using `.bashrc`.
2323
## Implementation details
2424

2525
- The CLI will use `sqlite` (subject to change?)
26+
- Each command will be implemented in a separate file in the `cmd/` directory
27+
- For `sessionable` commands, run the command for every session in the group.
2628

2729
## Scratchattach objects
2830

@@ -32,5 +34,32 @@ format: `-{object-type} {identifying info} ({other info})`
3234
- Studios `-S {id} (name)`
3335

3436
You can view more information about a user/project/studio using `sc` and then their format, e.g. `sc -P 104`.
35-
Doing this will also load up the object's identifying information, so that any immediate can relate to that project.
37+
Doing this will also save the object's identifying information in the database, so that any subsequent command can relate to that project.
3638
e.g. Loading `-P 104`, then doing `sc comment`, creating a prompt for a comment on the project with ID 104.
39+
40+
## Commands
41+
42+
If called without any params (`sc`), just display the help menu.
43+
44+
---
45+
46+
`sc messages -L [LIMIT] -O [OFFSET]`
47+
48+
Print out message activity with an offset & limit.
49+
50+
!!! Question
51+
52+
consider adding message type filters
53+
54+
---
55+
56+
`sc find -U [USERNAME] -S [STUDIO_ID] -P [PROJECT_ID] [SEARCH_PARAM]`
57+
58+
If no search param is provided, just show the user/project/session page instead.
59+
If no USERNAME is provided, default to the session username.
60+
61+
Options for search param:
62+
- `lovefeed` - Projects loved by scratchers I'm following
63+
- `loves` | `loved` - Loved projects (requires USERNAME)
64+
- `faves` | `faved` | `favorited` | `favorites` - Favorited projects (requires USERNAME)
65+
- `shared` - Shared projects (requires USERNAME)

0 commit comments

Comments
 (0)