Kanpachi

A subpar CLI for interacting with IBM i.

This has just been a little toy project I've been casually working on. I've only really tested it on my work's system with V7R3 and a bit on PUB400 with V7R4. So, this might not work very well for other people.

I'm sure someone could take some ideas or snippets from this and make something way better. This definitely needs a lot more polishing.

Features

• Connection profiles for different systems/users.
• Fetch files and directories from IFS.
• Fetch libraries, source physical files, and source members from QSYS.
• Execute CL, SQL, and shell commands.

Host Requirements

• IBM i V7R3+ - DSPSFWRSC to check OS version.
• User profile with home directory setup on IFS.

Client Requirements

• .NET Core runtime
• ODBC driver for IBM i

Setup

• Windows - docs/setup-windows.md
• Linux - docs/setup-linux.md
• Mac - Sorry, nothing personal; I don't know a single thing about MacOS.

Command Documentation

Here are a few sample commands to show some basic functionality.

• kanpachi profile add MY400 - create new profile
• kanpachi profile ls - list profiles
• kanpachi qsys get_mbr BOLIB/QRPGLESRC/IFSREAD ./rpgle - Download source member
• kanpachi qsys get_spf BOLIB/QRPGLESRC ./rpgle - Download source members in BOLIB/QRPGLESRC
• kanpachi qsys get_lib BOLIB - download all source physical files from BOLIB
• kanpachi ifs ls /home/OTTEB/ - list directory contents of /home/OTTEB
• kanpachi ifs get_dir /home/OTTEB/RPG-BF - download directory /home/OTTEB/RPG-BF (to current working directory)
• kanpachi exec cl "DSPLIBL" - execute CL command
• kanpachi exec sh "ls" - execute shell command
• kanpachi exec sql "select SYSTEM_SCHEMA_NAME from QSYS2.SYSSCHEMAS limit 25 - execute SQL command

Complete command documentation in docs/CLI-Docs.md

Recommended VS Code Extensions

• IBMi Languages - My syntax highlighter for RPG, RPGLE, CL, DDS, and MI.

Project Goals

• Phase 1 - CLI commands to create profiles, fetch source, and execute commands (SQL, CL, shell)
• Phase 2 - CLI commands to update source on IFS and QSYS
• Phase 3 - API over Kanpachi.LIB
• Phase 4 - VS Code extension (frontend) over Kanpachi.API (separate repository)

I'm only working on this project when I'm in the mood to. So, it might be awhile on a lot of this, if at all.

Additional Ideas

Stuff I was thinking about while developing, but haven't really started.

• Run Kanpachi CLI interactively (would need to add exit command)
• Generate markdown file for each library's QSYS metadata.
• Command to update local QSYS files based off QSYS metadata updated timestamp. (like git pull)
• Command to download a spooled file or all spooled files for a job.

References

• IBM i 7.3 Documentation
• IBM i DB2 Connection String Keywords
• SSH.NET
• RPGPGM
• CommandLineParser Documentation