https://github.com/dgac/asterix-tool
ASTERIX toolkit
https://github.com/dgac/asterix-tool
asterix cli nodejs
Last synced: about 1 year ago
JSON representation
ASTERIX toolkit
- Host: GitHub
- URL: https://github.com/dgac/asterix-tool
- Owner: DGAC
- License: gpl-3.0
- Created: 2020-02-27T21:26:11.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-18T21:05:55.000Z (almost 3 years ago)
- Last Synced: 2025-03-27T09:13:24.596Z (about 1 year ago)
- Topics: asterix, cli, nodejs
- Language: TypeScript
- Size: 378 KB
- Stars: 3
- Watchers: 4
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @dgac/asterix-tool
DGAC ASTERIX toolkit
[](https://oclif.io)
[](https://npmjs.org/package/@dgac/asterix-replay)
[](https://circleci.com/gh/kouak/asterix-replay/tree/master)
[](https://codecov.io/gh/kouak/asterix-replay)
[](https://npmjs.org/package/@dgac/asterix-replay)
[](https://github.com/kouak/asterix-replay/blob/master/package.json)
* [@dgac/asterix-tool](#dgacasterix-tool)
* [Usage](#usage)
* [Commands](#commands)
# Usage
```sh-session
$ npm install -g @dgac/asterix-tool
$ asterix-tool COMMAND
running command...
$ asterix-tool (-v|--version|version)
@dgac/asterix-tool/0.3.0 linux-x64 node-v14.3.0
$ asterix-tool --help [COMMAND]
USAGE
$ asterix-tool COMMAND
...
```
# Commands
* [`asterix-tool help [COMMAND]`](#asterix-tool-help-command)
* [`asterix-tool info SOURCE_FILE`](#asterix-tool-info-source_file)
* [`asterix-tool proxy MULTICAST-GROUP`](#asterix-tool-proxy-multicast-group)
* [`asterix-tool replay SOURCE_FILE`](#asterix-tool-replay-source_file)
## `asterix-tool help [COMMAND]`
display help for asterix-tool
```
USAGE
$ asterix-tool help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
```
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.1.0/src/commands/help.ts)_
## `asterix-tool info SOURCE_FILE`
Prints statistics about a PCAP package containing ASTERIX messages
```
USAGE
$ asterix-tool info SOURCE_FILE
ARGUMENTS
SOURCE_FILE Source PCAP file.
(note: the file can only contain ASTERIX traffic)
OPTIONS
-v, --verbose Verbose output
--source-format=udp4|macllc [default: udp4] Source format (udp4 or MAC/LLC)
```
_See code: [src/commands/info.ts](https://github.com/DGAC/asterix-tool/blob/v0.3.0/src/commands/info.ts)_
## `asterix-tool proxy MULTICAST-GROUP`
Proxies UDP multicast ASTERIX to a UNIX socket
```
USAGE
$ asterix-tool proxy MULTICAST-GROUP
ARGUMENTS
MULTICAST-GROUP Multicast group address.
e.g: 232.1.1.1 or ff02::fb
OPTIONS
-d, --destination=destination [default: udp4://localhost:8600] The destination to forward the ASTERIX messages to.
e.g: unix:/tmp/asterix.socket or udp4://localhost:8600
-i, --interface=interface [default: all] Network interface.
Default value is 'all'
-p, --port=port [default: 8600] Port number to listen to.
-v, --verbose Verbose output
```
_See code: [src/commands/proxy.ts](https://github.com/DGAC/asterix-tool/blob/v0.3.0/src/commands/proxy.ts)_
## `asterix-tool replay SOURCE_FILE`
Forwards ASTERIX packets from a pcap file to a unix or udp socket
```
USAGE
$ asterix-tool replay SOURCE_FILE
ARGUMENTS
SOURCE_FILE Source PCAP file.
(note: the file can only contain ASTERIX traffic)
OPTIONS
-d, --destination=destination [default: udp4://localhost:8600] The destination to forward the ASTERIX messages
to.
e.g: unix:/tmp/asterix.socket or udp4://localhost:8600
-n, --max-count=max-count Number of messages forwarded before exiting
-v, --verbose Verbose output
--source-format=udp4|macllc [default: udp4] Source format (udp4 or MAC/LLC)
--time-compression=time-compression [default: 1] Time compression factor.
For instance, a value of 2 will process the file twice at fast as it was record.
```
_See code: [src/commands/replay.ts](https://github.com/DGAC/asterix-tool/blob/v0.3.0/src/commands/replay.ts)_