Skip to content

Commit 264c851

Browse files
committed
Add CLI docs
1 parent 9f3efbd commit 264c851

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Much of the functionality of this package has been ported over from [tivars_lib_
1616
- [Documentation](#documentation)
1717
- [API](#api)
1818
- [Formatting Output](#formatting-output)
19+
- [CLI](#cli)
1920
- [Other Functionalities](#other-functionalities)
2021
- [PIL](#pil)
2122
- [Tokenization](#tokenization)
@@ -308,6 +309,20 @@ All entry types support string formatting using Python's f-strings.
308309

309310
Additionally, the `t` type is supported for types which can be made from tokens, composing the object out of typeable (accessible) token names. For example, `-2 + 5i` is presented as `~2+5[i]`.
310311

312+
## CLI
313+
314+
For simple var operations that don't need whole scripts to hoist, a command-line interface is offered via `python -m tivars ...`. If installed using `pip`, a top-level `tivars ...` command will also be registered.
315+
316+
The CLI is divided into three core functionalities.
317+
- `tivars convert`: Convert between file types, e.g. `TIProgram -> txt`, `png -> TIPicture`, etc.
318+
- `PIL` must be installed to import or export TI picture types
319+
- `tivars info`: Display basic information about a file
320+
- The same view can be obtained in the library using the `.summary()` method on an object
321+
- `tivars pack/unpack`: Manipulate groups and bundles
322+
- Placing multiple entries or flash headers into one file is also supported
323+
324+
Use `tivars --help` to get your bearings, and `tivars <subcommand> --help` to view all accepted arguments for a function listed above.
325+
311326
## Other Functionalities
312327

313328
### PIL

0 commit comments

Comments
 (0)