timeback-cli 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,59 @@
1
+ # timeback
2
+
3
+ CLI for the Timeback platform.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ bun add -g timeback
9
+ # or
10
+ bunx timeback
11
+ ```
12
+
13
+ ## Usage
14
+
15
+ ```bash
16
+ timeback <command> [options]
17
+ timeback --help
18
+ ```
19
+
20
+ ## Commands
21
+
22
+ ### `timeback api`
23
+
24
+ Interact with education data APIs.
25
+
26
+ ```bash
27
+ # Discovery
28
+ timeback api describe --service oneroster
29
+
30
+ # CRUD
31
+ timeback api oneroster schools list --env production
32
+ timeback api oneroster users get <id>
33
+ timeback api oneroster users create --file user.json
34
+ timeback api oneroster users delete <id>
35
+
36
+ # Filtering
37
+ timeback api oneroster enrollments list --active --classes id1,id2
38
+ timeback api oneroster users list --role teacher --max 100
39
+ ```
40
+
41
+ See `timeback api oneroster --help` for all resources and options.
42
+
43
+ ## Configuration
44
+
45
+ API clients read credentials from environment variables:
46
+
47
+ ```bash
48
+ # OneRoster
49
+ export ONEROSTER_BASE_URL="https://api.example.com"
50
+ export ONEROSTER_TOKEN_URL="https://auth.example.com/oauth2/token"
51
+ export ONEROSTER_CLIENT_ID="your-client-id"
52
+ export ONEROSTER_CLIENT_SECRET="your-client-secret"
53
+ ```
54
+
55
+ ## Debug Mode
56
+
57
+ ```bash
58
+ DEBUG=1 timeback api oneroster schools list
59
+ ```
@@ -0,0 +1,7 @@
1
+ /**
2
+ * Config types for timeback.config.ts files.
3
+ *
4
+ * Re-exported from `@timeback/types` so users can import 'timeback/config'
5
+ * for editor IntelliSense in TS config files.
6
+ */
7
+ export type { CourseConfig, CourseDefaults, CourseGoals, CourseIds, CourseMetadata, CourseMetrics, CourseType, PublishStatus, TimebackConfig, } from '@timeback/types';