Skip to content
This repository has been archived by the owner on Sep 7, 2024. It is now read-only.

doc: adding usage documentation #100

Merged
merged 1 commit into from
Dec 27, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions doc/usage/usage.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,44 @@
# Usage of time trace

Currently you can run your timetrace instance using [ttrace CLI](../../cmd/main.go).
You can download latest version based on your OS and CPU arch [here](https://github.com/zurvan-lab/TimeTrace/releases).

## checking installation

You can check if you are installed ttrace properly:
```sh
ttrace --version
```

And:
```sh
ttrace --help
```

## run an instance

To run an new instance you can simply make a `config.yaml` file as config first.

> NOTE: see config details [here](../config/config.md).

Then run your instance:

```sh
ttrace run -c {path-to-your-config.yaml}
```

## connecting with REPL

You can use ttrace CLI to connect to your instance and execute TQL queries:

```sh
ttrace connect -u username -p password -a remote-address
```

## other commands

Checl ttrace `--help` to find-out more commands.

## other usage ways

You can also implement or use a timetrace client or drive which have timetrace an TQL protocol and language implemented to run or interact with a timetrace instance.
Loading