{"id":18085052,"url":"https://github.com/jwodder/confab","last_synced_at":"2025-09-15T20:45:59.032Z","repository":{"id":63557333,"uuid":"568575663","full_name":"jwodder/confab","owner":"jwodder","description":"Asynchronous line-oriented interactive TCP client","archived":false,"fork":false,"pushed_at":"2025-09-15T14:05:56.000Z","size":1172,"stargazers_count":5,"open_issues_count":8,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-09-15T16:09:23.483Z","etag":null,"topics":["available-on-crates-io","chat","client","rust","tcp"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jwodder.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-11-20T23:52:12.000Z","updated_at":"2025-09-15T14:05:59.000Z","dependencies_parsed_at":"2023-02-10T04:01:01.109Z","dependency_job_id":"9170a067-bee7-4603-ad5b-f3e8c1f9ec83","html_url":"https://github.com/jwodder/confab","commit_stats":{"total_commits":273,"total_committers":2,"mean_commits":136.5,"dds":0.3846153846153846,"last_synced_commit":"06cf7e7132be7240513bdffe4b06e19f7cf3e451"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/jwodder/confab","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwodder%2Fconfab","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwodder%2Fconfab/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwodder%2Fconfab/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwodder%2Fconfab/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jwodder","download_url":"https://codeload.github.com/jwodder/confab/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jwodder%2Fconfab/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275320089,"owners_count":25443827,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-15T02:00:09.272Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["available-on-crates-io","chat","client","rust","tcp"],"created_at":"2024-10-31T15:09:13.588Z","updated_at":"2025-09-15T20:45:58.983Z","avatar_url":"https://github.com/jwodder.png","language":"Rust","readme":"[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)\n[![CI Status](https://github.com/jwodder/confab/actions/workflows/test.yml/badge.svg)](https://github.com/jwodder/confab/actions/workflows/test.yml)\n[![codecov.io](https://codecov.io/gh/jwodder/confab/branch/master/graph/badge.svg)](https://codecov.io/gh/jwodder/confab)\n[![Minimum Supported Rust Version](https://img.shields.io/badge/MSRV-1.86-orange)](https://www.rust-lang.org)\n[![MIT License](https://img.shields.io/github/license/jwodder/confab.svg)](https://opensource.org/licenses/MIT)\n\n[GitHub](https://github.com/jwodder/confab) | [crates.io](https://crates.io/crates/confab) | [Issues](https://github.com/jwodder/confab/issues) | [Changelog](https://github.com/jwodder/confab/blob/master/CHANGELOG.md)\n\n`confab` is an asynchronous line-oriented interactive TCP client with TLS\nsupport.  Use it to connect to a TCP server, and you'll be able to send\nmessages line by line while lines received from the remote server are printed\nabove the prompt.\n\n![Recording of an example session](https://github.com/jwodder/confab/raw/master/example.gif)\n\nInstallation\n============\n\nRelease Assets\n--------------\n\nPrebuilt binaries for the most common platforms are available as GitHub release\nassets.  [The page for the latest\nrelease](https://github.com/jwodder/confab/releases/latest) lists these under\n\"Assets\", along with installer scripts for both Unix-like systems and Windows.\n\nAs an alternative to the installer scripts, if you have\n[`cargo-binstall`](https://github.com/cargo-bins/cargo-binstall) on your\nsystem, you can use it to download \u0026 install the appropriate release asset for\nyour system for the latest version of `confab` by running `cargo binstall\nconfab`.\n\nCargo\n-----\n\nIf you have [Rust and Cargo\ninstalled](https://www.rust-lang.org/tools/install), you can build the latest\nrelease of `confab` and install it in `~/.cargo/bin` by running:\n\n    cargo install confab\n\n`confab` has the following Cargo features, selectable via the `--features\n\u003cLIST\u003e` option to `cargo install`:\n\n- `rustls` — Use [`rustls`](https://github.com/rustls/rustls) for TLS support.\n\n    - This feature is enabled by default, and it overrides any other features;\n      hence, in order to enable the `native` or `vendored-openssl` feature, the\n      `--no-default-features` option must be passed to `cargo install` in\n      addition to the `--features ...` option.\n\n    - The release assets are built with this feature enabled.\n\n- `native` — Use [`native-tls`](https://github.com/sfackler/rust-native-tls)\n  for TLS support.\n\n- `vendored-openssl` — Compile a vendored copy of OpenSSL into `confab` instead\n  of using the platform's copy at runtime.  This makes it possible to build\n  `confab` on one system and run it on another system that has a different\n  version of OpenSSL.\n\n    - This feature implies the `native` feature.\n\n    - This option is not meaningful on macOS or Windows, on which `confab` does\n      not use OpenSSL for TLS connections.\n\n\nUsage\n=====\n\n    confab [\u003coptions\u003e] \u003chost\u003e \u003cport\u003e\n\nOpen a TCP connection to the given host and port.  Lines entered by the user at\nthe `confab` prompt are sent to the remote server and echoed locally with a\n\"`\u003e`\" prefix, while lines received from the remote server are printed out above\nthe prompt with a \"`\u003c`\" prefix.  Communication stops when the remote server\ncloses the connection or when the user presses Ctrl-D.\n\n`confab` relies on\n[`rustyline-async`](https://github.com/zyansheep/rustyline-async) for its\nreadline-like capabilities; see there for the supported control sequences.\n\nOptions\n-------\n\n- `--build-info` — Display a summary of the program's build information \u0026\n  dependencies and exit\n\n- `--crlf` — Append CR LF (`\"\\r\\n\"`) to each line sent to the remote server\n  instead of just LF (`\"\\n\"`)\n\n- `-E \u003cencoding\u003e`, `--encoding \u003cencoding\u003e` — Set the text encoding for the\n  connection.  The available options are:\n\n    - `utf8` *(default)* — Use UTF-8.  If a line received from the remote\n      server contains an invalid UTF-8 sequence, the sequence is replaced with\n      U+FFFD REPLACEMENT CHARACTER (`�`).\n\n    - `utf8-latin1` — Use UTF-8.  If a line received from the remote server\n      contains an invalid UTF-8 sequence, the entire line is instead decoded as\n      Latin-1.  (Useful for IRC!)\n\n    - `latin1` — Use Latin-1 (a.k.a. ISO-8859-1).  If a line sent to the remote\n      server contains non-Latin-1 characters, they are replaced with question\n      marks (`?`).\n\n- `-h`, `--help` — Display a summary of the command-line options and exit\n\n- `--max-line-length \u003cLIMIT\u003e` — Set the maximum length in bytes of each line\n  read from the remote server (including the terminating newline).  If the\n  server sends a line longer than this, the first `\u003cLIMIT\u003e` bytes will be split\n  off and treated as a whole line, with the remaining bytes treated as the\n  start of a new line.  [default value: 65535]\n\n- `--servername \u003cDOMAIN\u003e` — (with `--tls`) Use the given domain name for SNI\n  and certificate hostname validation; defaults to the remote host name\n\n- `--startup-wait-ms \u003cINT\u003e` — Specify the time to wait in milliseconds\n  before sending each line of the startup script [default value: 500]\n\n- `-S \u003cFILE\u003e`, `--startup-script \u003cFILE\u003e` — On startup, read lines from the\n  given file and send them to the server one at a time.  The user will not be\n  prompted for input until after the end of the file is reached.\n\n- `-t`, `--show-times` — Prepend a timestamp of the form `[HH:MM:SS]` to each\n  line printed to the terminal\n\n- `--tls` — Connect using SSL/TLS\n\n- `-T \u003cFILE\u003e`, `--transcript \u003cFILE\u003e` — Append a transcript of events to the\n  given file.  See [Transcript Format](#transcript-format) below for more\n  information.\n\n- `-V`, `--version` — Show the program version and exit\n\n\nTranscript Format\n=================\n\nThe session transcripts produced by the `--transcript` option take the form of\nJSON Lines (a.k.a. newline-delimited JSON), that is, a series of lines with one\nJSON object per line.  Each JSON object represents an event such as a line\nsent, a line received, or the start or end of the connection.\n\nEach object contains, at minimum, a `\"timestamp\"` field containing a timestamp\nfor the event in the form `\"YYYY-MM-DDTHH:MM:SS.ssssss+HH:MM\"` and an `\"event\"`\nfield identifying the type of event.  The possible values for the `\"event\"`\nfield, along with any accompanying further fields, are as follows:\n\n- `\"connection-start\"` — Emitted just before starting to connect to the remote\n  server.  The event object also contains `\"host\"` and `\"port\"` fields listing\n  the remote host \u0026 port specified on the command line.\n\n- `\"connection-complete\"` — Emitted after connecting successfully (but before\n  negotiating TLS, if applicable).  The event object also contains a\n  `\"peer_ip\"` field listing the remote IP address that the connection was made\n  to.\n\n- `\"tls-start\"` — Emitted before starting the TLS handshake.  The event object\n  has no additional fields.\n\n- `\"tls-complete\"` — Emitted after completing the TLS handshake.  The event\n  object has no additional fields.\n\n- `\"recv\"` — Emitted whenever a line is received from the remote server.  The\n  event object also contains a `\"data\"` field giving the line received,\n  including trailing newline (if any).\n\n- `\"send\"` — Emitted whenever a line is send to the remote server.  The event\n  object also contains a `\"data\"` field giving the line sent, including\n  trailing newline (if any).\n\n- `\"disconnect\"` — Emitted when the connection is closed normally.  The event\n  object has no additional fields.\n\n- `\"error\"` — Emitted when a fatal error occurs.  The event object also\n  contains a `\"data\"` field giving a human-readable error message.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjwodder%2Fconfab","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjwodder%2Fconfab","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjwodder%2Fconfab/lists"}