📝 Add completion and handling of decorated imports (#438)

This commit is contained in:
Eric Doughty-Papassideris
2024-03-26 12:06:22 +01:00
committed by ericlinagora
parent b872d64ab3
commit 8a46780d3f
2 changed files with 13 additions and 5 deletions
+11 -5
View File
@@ -41,7 +41,7 @@ will run unit tests only (`test:unit`). For possible tests to run, check the `pa
The Twake backend CLI
The Twake backend CLI provides a set of commands to manage/use/develop Tdrive from the `twake-cli` executable.
Before using the CLI, you must `compile` Tdrive with `npm run build`. Once done, you can get help on on any command with the `--help` flag like `./bin/twake-cli --help`.
Before using the CLI, you must `compile` Tdrive with `npm run build`. Once done, you can get help on on any command with the `--help` flag like `bin/twake-cli --help`.
It uses the same configuration as the Tdrive backend application. Including environment variables and the `./config/default.json` file.
@@ -50,9 +50,6 @@ It uses the same configuration as the Tdrive backend application. Including envi
This command re-indexes entities of the given repository from the database to the search service.
```sh
<<<<<<< HEAD
./bin/twake-cli search index --repository users --repairEntities
=======
bin/twake-cli search index --repository users --repairEntities
```
@@ -66,7 +63,16 @@ choices (or we're using it wrong).
```sh
eval "$(bin/twake-cli completion)"
>>>>>>> c95ca33f (fixup! 📝 Updating README.md with CLI example (#438))
```
#### Bash completion
It's a bit awkward to do real completion from a configuration since this isn't really a node module we recommend to install globally.
This should setup a shell if you're in the right path however. It's yarg's auto generated completion though; so eg: it mixes up commands and
choices (or we're using it wrong).
```sh
eval "$(bin/twake-cli completion)"
```
### Component Framework
+2
View File
@@ -1,3 +1,4 @@
import "reflect-metadata";
import yargs from "yargs";
import { logger } from "../core/platform/framework/logger";
@@ -24,5 +25,6 @@ yargs
.alias("help", "h")
.help("help")
.version()
.completion("completion")
.epilogue("for more information, go to https://tdrive.app")
.example("$0 <command> --help", "show help of the issue command").argv;