@tscircuit/cli 0.0.5 → 0.0.8

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.
Files changed (30) hide show
  1. package/README.md +31 -22
  2. package/bun.lockb +0 -0
  3. package/dev-server-frontend/bun.lockb +0 -0
  4. package/dist/cli.js +557 -211
  5. package/lib/cmd-fns/add.ts +34 -0
  6. package/lib/cmd-fns/config-reveal-location.ts +1 -1
  7. package/lib/cmd-fns/dev/check-if-initialized.ts +22 -0
  8. package/lib/cmd-fns/dev/index.ts +25 -9
  9. package/lib/cmd-fns/dev/infer-export-name-from-source.ts +17 -0
  10. package/lib/cmd-fns/dev/soupify-and-upload-example-file.ts +2 -17
  11. package/lib/cmd-fns/dev-server-upload.ts +26 -0
  12. package/lib/cmd-fns/index.ts +5 -0
  13. package/lib/cmd-fns/init/create-or-modify-npmrc.ts +21 -0
  14. package/lib/cmd-fns/init/get-generated-npmrc.ts +8 -0
  15. package/lib/cmd-fns/init/get-generated-readme.ts +34 -0
  16. package/lib/cmd-fns/init/get-generated-tsconfig.ts +34 -0
  17. package/lib/cmd-fns/{init.ts → init/index.ts} +26 -63
  18. package/lib/cmd-fns/install.ts +34 -0
  19. package/lib/cmd-fns/publish/index.ts +296 -0
  20. package/lib/cmd-fns/remove.ts +31 -0
  21. package/lib/cmd-fns/uninstall.ts +31 -0
  22. package/lib/get-program.ts +48 -7
  23. package/lib/util/create-context-and-run-program.ts +1 -1
  24. package/lib/util/get-all-package-files.ts +35 -0
  25. package/package.json +9 -5
  26. package/tests/assets/example-project/README.md +18 -0
  27. package/tests/assets/example-project/index.ts +1 -0
  28. package/tests/assets/example-project/package.json +2 -1
  29. package/tests/init.test.ts +1 -1
  30. package/lib/cmd-fns/publish.ts +0 -3
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # `tsck` - The TSCircuit Command Line Tool
1
+ # `tsci` - The TSCircuit Command Line Tool
2
2
 
3
3
  Command line tool for developing tscircuit projects and interacting with the
4
4
  tscircuit registry.
@@ -11,39 +11,48 @@ npm install -g @tscircuit/cli
11
11
 
12
12
  ## Usage
13
13
 
14
- The `tsck` CLI is interactive by default. You can specify the `-y` or any fully-
14
+ The `tsci` CLI is interactive by default. You can specify the `-y` or any fully-
15
15
  qualified with all required arguments to skip the interactive mode.
16
16
 
17
17
  ```bash
18
18
  # Interactively choose a command and options:
19
- tsck
19
+ tsci
20
20
 
21
21
  # Login
22
- tsck login
22
+ tsci login
23
23
 
24
24
  # Create a Project
25
- tsck init
25
+ tsci init
26
26
 
27
- # Develop a Project
28
- tsck dev # build, view and edit circuit files in browser
27
+ # Develop a Project (preview, export, and edit circuit files in browser)
28
+ tsci dev
29
29
 
30
30
  # Manage Dependencies
31
- tsck install
32
- tsck add some-package
33
- tsck remove some-package
31
+ tsci install
32
+ tsci add some-package
33
+ tsci remove some-package
34
34
 
35
- # Lint a Project
36
- tsck lint
37
- tsck lint 2024 # use 2024 tscircuit recommendations
35
+ # Publish a Project
36
+ tsci publish
37
+ ```
38
38
 
39
- # Format a Project
40
- tsck format
41
- tsck format 2024
39
+ ## Developing
42
40
 
43
- # Publish a Project
44
- tsck publish
41
+ This project is developed with [bun](https://bun.sh/), make sure you have
42
+ that installed.
45
43
 
46
- # View Your Project on Registry
47
- tsck open
48
- tsck view
49
- ```
44
+ Run `bun boostrap` to install dependencies and `bun cli.ts` to run test the cli in development.
45
+
46
+ To run tests, run `bun test`
47
+
48
+ When you're developing the dev-server, you should do the following:
49
+
50
+ 1. Run the development server with `bun start:dev-server:dev`
51
+ 2. Upload examples using `bun dev-server upload --watch ./tests/assets/example-project`
52
+ 3. Visit `http://localhost:3020` in your browser
53
+
54
+ ## Features Coming Soon
55
+
56
+ - [`tsci format`](https://github.com/tscircuit/cli/issues/1)
57
+ - [`tsci lint`](https://github.com/tscircuit/cli/issues/2)
58
+ - [`tsci open`](https://github.com/tscircuit/cli/issues/4)
package/bun.lockb CHANGED
Binary file
package/dev-server-frontend/bun.lockb CHANGED
Binary file