Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nikvoronin/toptout-cli
Easily opt-out from telemetry collection --through interactive -command-line
https://github.com/nikvoronin/toptout-cli
Last synced: about 2 months ago
JSON representation
Easily opt-out from telemetry collection --through interactive -command-line
- Host: GitHub
- URL: https://github.com/nikvoronin/toptout-cli
- Owner: nikvoronin
- License: mit
- Archived: true
- Created: 2021-03-03T15:35:11.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-06-06T18:43:53.000Z (over 1 year ago)
- Last Synced: 2024-08-03T21:03:45.400Z (5 months ago)
- Language: C#
- Size: 156 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- toptout - nikvoronin/toptout-cli
README
# [Toptout](https://github.com/beatcracker/toptout) interactive --command-line
>⚠ This project is discontinued because [the main one](https://github.com/beatcracker/toptout) has already implemented multiplatform scripting gears.
## Requirements
.NET 5
### Prototype
- python 3
- argparser
- json
- requests
## Turn Off Telemetry
`toptout-cli`
Print recommends about `update` if it cannot find local db file `toptout.json`.
The options list i.e. user defined options are in the [options.txt](#opt-out-options)
- toptout-cli `--option` my-rules.txt
## Update
- toptout-cli `update`
- toptout-cli `force`
Download `.json` datas from `https://github.com/beatcracker/toptout/tree/master/data` and consolidate it in a local db. Also creates the `user-options` file.
### Swagger Api Provider
How to download data
> toptout-cli update `--provider swagger`
### Github Native Api Provider
```text
https://github.com/johnydou/teleoff/tree/master/telemetry/data/json
^^^^^^^^/^^^^^^^ ^^^^^^ ^^^^^^^^^/^^^^/^^^^
user..../repo... branch path...../..../....
```
> toptout-cli update `--provider github` --repo 'johnydou/teleoff/master' --path '/telemetry/data/json'
- `--provider github`
- `--repo` 'username/repository/branch'
- `--user-repo-branch` 'johnydou/teleoff/main'
- `--path` '/telemetry/data/json'
## ¿ Revert / Undo ?
- `toptout-cli -r`
- `toptout-cli --revert`
- `toptout-cli --undo`
`?` Revert or undoing all changes
## Print Help
- `toptout-cli -h`
- `toptout-cli --help`
## Diagnostics
print, show, dry, list, ...
## Opt-out Options
User can opts in a autogenerated file `options.txt`
1. `+-._` without spaces. But some symbols can appear, like parenthesis [], (), }}.
- `[+]` turn _tm_ on
- `[-]` switch _tm_ off
- `[_]`, `[ ]` , `[.]` do nothing or ignore. Default behavior
2. Any spacers like space or tab
3. Name of the module
```plain
[-] switch telemetry off
(+) turn telemetry back again
{-} name of the module
|+| name of the module 2
[.] ignore opts for module_name_3
[ ] do nothing for module_that_called_four
[_] still do nothing mod-5
... ...
[-] name of the module N
```