An ZFS administration tool inspired on Midnight commander

Last update: Dec 07, 2022

Related tags

Command-line Tools zc

Overview

ZC - ZFS Commander

An ZFS administration tool inspired on Midnight commander

Work in Progress

Description

ZFS Commander is a simple front-end for the most commonly used zpool & zfs commands. While the tool is a work-in-progress, several functions are already working. See the list of functions implemented in Usage section.

The tool is composed of 2 panes, each showing different ZFS related information. The tool will start with Datasets at left and Snapshots at the right pane. By pressing TAB, each window will cycle through the different modes: Pools, Datasets, Volumes and Snapshots.

Installation

ZFS commander is build on Rust language, so make sure to have Rust installed on your machine. Instructions can be found here: https://www.rust-lang.org/tools/install

To compile and install ZFS comamnder, run the following commands:

$ sudo apt install build-essential ncurses-dev
$ make
$ sudo make install
$ make clean

To uninstall run:

$ sudo make uninstall

Usage

As the execution of some ZFS operations require higher privilege run ZFS commander with sudo or doas:

$ sudo zc

Operation

Use TAB key to switch between the modes available.

Use LEFT or RIGHT keys to navigate in between the two windows.

Function Keys per Mode

Key	Pool	Dataset	Snapshot	Volume
F1	Help	Help	Help	Help
F2	-	zfs promote	zfs diff	-
F3	-	-	zfs send	-
F4	-	-	-	-
F5	-	zfs snapshot	zfs clone	zfs snapshot
F6	-	zfs rename	zfs rename	zfs rename
F7	zpool scrub	zfs create	zfs rollback	zfs create
F8	zpool destroy	zfs destroy	zfs destroy	zfs destroy
F9	zpool get all	zfs get all	zfs get all	zfs get all
F10	Exit	Exit	Exit	Exit

NOTE: F9 Get All window enables individual properties to be directly edited.

Comments

New Feature: Explicit refresh

The data can become stale while zc is running.

For example, if a snapshot is created or destroyed, outside of zc, those changes will not appear in zc until something causes that list to be reloaded. An explicit command to refresh current data would be handy.

opened by dodexahedron 0
New Feature: Allow setting user-defined properties

ZFS supports user-defined properties, as long as they have a colon in the name.

It would be handy if zc had a way to add/set/remove user properties on datasets.

Documentation for reference: https://openzfs.github.io/openzfs-docs/man/8/zfsprops.8.html#User_Properties

opened by dodexahedron 0
Suggestion: Tree view instead of tabbed panes

We can see pool, volume, dataset, and snapshot information in zc. However, there's a logical organization to those things that naturally fits a tree.

For example, it was a little unintuitive, to me, that, if I have a specific dataset highlighted, all the snapshots across all datasets are listed.

A tree organization, sorta like one might find in targetcli, seems like it would provide a much friendlier user experience.

Then, perhaps, whatever object is selected in said tree would have its properties automatically displayed on the right pane.

opened by dodexahedron 0
Non-settable properties should not allow the user to attempt to edit them

When in the dataset properties list, it is possible to attempt to edit non-settable properties, though of course attempts to do so will fail. If a property is not settable, the edit dialog should simply not come up.

opened by dodexahedron 0
Suggestion: Command hints should indicate they are F-keys

As title says. Yes, the documentation points it out, but it would be much clearer if the program showed F1, F2, etc, rather than just the numbers. I wondered if my system was missing a component or something until I went back to the documentation to see that they are, in fact, the F-keys. My first instinct was to try ctrl-1, alt-1, etc. F1 didn't occur to me right away.

opened by dodexahedron 0

Releases(v1.1.0)

v1.1.0(Aug 25, 2020)

General refactoring and inclusion of message_box for command results
Source code(tar.gz)
Source code(zip)
v1.0.0(Aug 2, 2020)

Initial feature-set targeted for V1.0.0 has been achieved. Included binary file are for LINUX.
Source code(tar.gz)
Source code(zip)
zc(2.87 MB)

Owner

GitHub Repository

An ZFS administration tool inspired on Midnight commander

Related tags

Overview

ZC - ZFS Commander

Description

Installation

Usage

Operation

Comments

New Feature: Explicit refresh

New Feature: Allow setting user-defined properties

Suggestion: Tree view instead of tabbed panes

Non-settable properties should not allow the user to attempt to edit them

Suggestion: Command hints should indicate they are F-keys

Releases(v1.1.0)

v1.1.0(Aug 25, 2020)

v1.0.0(Aug 2, 2020)

Owner

Tiny command-line utility for mapping broken keys to other positions.

ForX - get forex quotes from the terminal

Command-line script to upload videos to Youtube using theYoutube APIv3.

Autosub - Command-line utility for auto-generating subtitles for any video file

PyArmor is a command line tool used to obfuscate python scripts

CLI to show end-of-life dates for tools and technologies.

Simple Terminal Styling for Python

Euporie is a text-based user interface for running and editing Jupyter notebooks

Chameleon is yet another PowerShell obfuscation tool designed to bypass AMSI and commercial antivirus solutions.

CLI tool to view your VIT timetable from terminal anytime!

pypinfo is a simple CLI to access PyPI download statistics via Google's BigQuery.

tiptop is a command-line system monitoring tool in the spirit of top.

Command line tool for monitoring changes of File entities scoped in a Synapse File View

Fast as FUCK nvim completion. SQLite, concurrent scheduler, hundreds of hours of optimization.

Openstack bucket retention cli

A python CLI app that converts a mp4 file into a gif with ASCII effect added.

img-proof (IPA) provides a command line utility to test images in the Public Cloud

Unconventional ways to save an Image

inklayers is a command line program that exports layers from an SVG file.

A simple and easy-to-use CLI parse tool.