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

Commit

Permalink
doc: adding usage documentation (#100)
Browse files Browse the repository at this point in the history
  • Loading branch information
kehiy authored Dec 27, 2023
1 parent 10a4496 commit 467edb6
Showing 1 changed file with 42 additions and 0 deletions.
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.

0 comments on commit 467edb6

Please sign in to comment.