Skip to content

recommand/recommand-transmit-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Recommand Transmit CLI

A command-line interface for interacting with the Recommand Peppol API. This tool provides utilities to download documents from your inbox, merge attachments with JSON documents, and manage Peppol communication workflows.

Features

  • Download Inbox Documents: Download all documents from your Recommand inbox with attachments
  • Merge Attachments: Combine JSON documents with attachment files for upload
  • Configuration Management: Simple TOML-based configuration system
  • Multiple File Format Support: CSV, PDF, PNG, JPEG, XLSX, and ODS files

Installation

Prerequisites

  • Go
  • A Recommand Peppol API account with valid credentials

Build from Source

git clone https://github.com/brbxai/recommand-transmit-cli.git
cd recommand-transmit-cli
# Native build
go build -o recommand-transmit-cli
# Windows 64-bit build
GOOS=windows GOARCH=amd64 go build -o recommand-transmit-cli.exe

Configuration

  1. Copy the example configuration file:

    cp config.toml.example config.toml
  2. Edit config.toml with your API credentials:

    [api]
    url = "https://peppol.recommand.eu"
    key = "your-api-key"
    secret = "your-api-secret"
    team_id = "your-team-id"

The configuration file can be placed in:

  • Current directory (config.toml)
  • User home directory (~/.recommand/config.toml)

Usage

Download Inbox Documents

Download all documents from your inbox to a local directory:

./recommand-transmit-cli inbox download /path/to/output/directory

This command will:

  • Fetch all unread documents from your inbox
  • Save each document as XML and JSON (if parsed)
  • Extract and save all attachments
  • Mark documents as read after successful download

Merge Attachments

Combine a JSON document with attachment files:

./recommand-transmit-cli merge input.json output.json attachment1.pdf attachment2.png

Supported file types:

  • CSV files (.csv)
  • PDF documents (.pdf)
  • PNG images (.png)
  • JPEG images (.jpg, .jpeg)
  • Excel spreadsheets (.xlsx)
  • OpenDocument spreadsheets (.ods)

Development

Dependencies

The project uses the following main dependencies:

  • github.com/spf13/cobra - CLI framework
  • github.com/BurntSushi/toml - TOML configuration parsing

License

This project is licensed under the MIT License.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Languages