Skip to main content

Terminal application to interact with Flux jobs, cheat sheets, code, and good fortune

Project description

Fluxterm

🦩️ I find this highly ridulous. And highly excellent.

Flux... from a terminal! This is a small terminal application that will provide a handle to interact with Flux, but also other useful UI interactions that are nice to have. We currently have:

  • A simple code browser
  • A flux jobs interface to see (and possibly TBA interact) with jobs
  • A flux cheat sheet for quick reference
  • Fortune and wisdom from flux bird, the pink bird who knows things.

Coming soon:

  • Interactive jobs table

Screenshots

The application enters with a code browser for the present working directory. The code browser is handy for navigating around your current directory of files.

https://github.com/converged-computing/fluxterm/blob/main/docs/img/code-browser.png?raw=true

The cheat sheets isn't the complete Flux documentation, but offers a quick, command line reference.

https://github.com/converged-computing/fluxterm/blob/main/docs/img/cheat-sheet.png?raw=true

Every view also has a light mode (we default to dark).

https://github.com/converged-computing/fluxterm/blob/main/docs/img/cheat-sheet-light.png?raw=true

The jobs table provides a quick interface to view flux jobs. We plan to add more interactivity to this, for example, clicking a flux job to get more metadata or output.

https://github.com/converged-computing/fluxterm/blob/main/docs/img/jobs-table.png?raw=true

Finally, if you ask for help? You get to talk with the "pink bird who knows things" Flux Bird.

https://github.com/converged-computing/fluxterm/blob/main/docs/img/flux-bird.png?raw=true

If you'd like a feature added, please let us know! It is currently bare bones, and development of this project will happen per user request.

TODO

  • Add emoji status to the jobs table
  • Job table interactivity

License

HPCIC DevTools is distributed under the terms of the MIT license. All new contributions must be made under this license.

See LICENSE, COPYRIGHT, and NOTICE for details.

SPDX-License-Identifier: (MIT)

LLNL-CODE- 842614

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fluxterm-0.0.0.tar.gz (21.0 kB view details)

Uploaded Source

Built Distribution

fluxterm-0.0.0-py3-none-any.whl (21.5 kB view details)

Uploaded Python 3

File details

Details for the file fluxterm-0.0.0.tar.gz.

File metadata

  • Download URL: fluxterm-0.0.0.tar.gz
  • Upload date:
  • Size: 21.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.5

File hashes

Hashes for fluxterm-0.0.0.tar.gz
Algorithm Hash digest
SHA256 43f1e086f427e92d9c6459a4f85c0686f6ca5929054d30f6135eac10390600c8
MD5 c86821c062327093405702fc7955e4d5
BLAKE2b-256 306b4cfb04c0d7ed24ad34b0c877a6bc7fa53cffbba3e8176881a059fc99d4f8

See more details on using hashes here.

File details

Details for the file fluxterm-0.0.0-py3-none-any.whl.

File metadata

  • Download URL: fluxterm-0.0.0-py3-none-any.whl
  • Upload date:
  • Size: 21.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.5

File hashes

Hashes for fluxterm-0.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6f4ac772e255ddd10022c99f2f79394da60c22ac57ac50deb88c720751406132
MD5 780a79170030d474c8e29c86a1b6b962
BLAKE2b-256 25291bc51cbb28909df9ca16cb7c54f2f1ff18c72f41068a49e190679a428f1b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page