Skip to main content

Neptun is a Python-based CLI for interacting with Neptun AI via the Neptun API interface, designed to answer questions on DevOps, Docker, Docker Compose, and more.

Project description

Neptun CLI

Neptun is a Python-based CLI for interacting with Neptun AI via the Neptun API interface. It is designed to answer questions on DevOps, Docker, Docker Compose, and more.

Features

  • Rich command-line interface using Typer
  • Styled output using Rich
  • Interactive prompts via Questionary
  • Seamless authentication and configuration management
  • Integration with GitHub and template collections

Installation

You can install Neptun via pip:

pip install neptun

Usage

Once installed, you can access Neptun using the neptun command.

neptun --help

Available Commands

General Options

--install-completion    Install completion for the current shell.
--show-completion      Show completion for the current shell.
--help                 Show this message and exit.

Core Commands

Command Description
config Manage general settings for the application.
auth Connect to the Neptun web client.
assistant Chat with the Neptun chatbot.
collection Manage your Neptun collections.
github Manage imported repositories & use the Neptun GitHub application.
info Display the current status and version of Neptun.
open Open the Neptun web interface.
health Check the status of the Neptun API.
template Manage templates in your collections.
project Create and manage Neptun projects.

Command Details

neptun config

Manage and configure general settings:

neptun config --help

Subcommands:

  • dynamic – Edit app settings dynamically.
  • fallback – Reset to default settings.
  • session-token – Update authentication token.
  • init – Initialize configuration from the web UI.
  • status – Get current configuration and user details.

neptun auth

Authenticate with Neptun:

neptun auth --help

Subcommands:

  • login – Log into your Neptun account.
  • register – Create a new Neptun account.
  • status – View authentication status.
  • send-otp – Send a one-time password.
  • reset-password – Reset password using OTP.

neptun assistant

Chat with Neptun AI:

neptun assistant --help

Subcommands:

  • options – List available options.
  • list – Show chat dialogs.
  • enter – Enter a chat dialog.
  • delete – Remove a chat dialog.
  • create – Start a new chat dialog.
  • select – Select an active chat dialog.
  • update – Modify an existing chat.
  • ask – Ask a question.

neptun collection

Manage collections:

neptun collection --help

Subcommands:

  • options – List available template options.
  • create-empty – Create a new empty collection.
  • list – Show existing collections.
  • list-shared – Show shared collections.
  • delete – Remove a collection.
  • update – Modify a collection.
  • inspect – View collection details.
  • create – Generate a collection from local files.
  • pull – Download a collection from Neptun.

neptun github

Manage GitHub integrations:

neptun github --help

Subcommands:

  • install – Install the Neptun GitHub app on a repository.
  • list-imports – View imported repositories.
  • uninstall – Remove the Neptun GitHub app.

neptun template

Manage templates:

neptun template --help

Subcommands:

  • delete – Remove a template from a collection.

neptun project

Work with Neptun projects:

neptun project --help

Subcommands:

  • create – Start a new Neptun project.

License

This project is licensed under The Unlicense.

Authors

  • stevan06v
  • jonasfroeller

For more details, visit Neptun's official repository.

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

neptun-0.1.12.tar.gz (34.5 kB view details)

Uploaded Source

Built Distribution

neptun-0.1.12-py3-none-any.whl (44.2 kB view details)

Uploaded Python 3

File details

Details for the file neptun-0.1.12.tar.gz.

File metadata

  • Download URL: neptun-0.1.12.tar.gz
  • Upload date:
  • Size: 34.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.12.9 Darwin/24.3.0

File hashes

Hashes for neptun-0.1.12.tar.gz
Algorithm Hash digest
SHA256 41c1a278a46e377c3468f1cc82713be6b464e969a23c9320a76ae1c73e826d30
MD5 4e5a562b2bda5e06df02af4c548ad802
BLAKE2b-256 bbbcf20135bfd867fbb547942af55e1001058425c252201569ed11931e2b47a7

See more details on using hashes here.

File details

Details for the file neptun-0.1.12-py3-none-any.whl.

File metadata

  • Download URL: neptun-0.1.12-py3-none-any.whl
  • Upload date:
  • Size: 44.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.12.9 Darwin/24.3.0

File hashes

Hashes for neptun-0.1.12-py3-none-any.whl
Algorithm Hash digest
SHA256 cb69c24fa3568c0e61a065d7e77ae177ab200181f2d0d4593183e2b7eca5a93a
MD5 a9cc358e316b2a31bd0b34d83a4898f4
BLAKE2b-256 8c4a590efb1c577ebe643ae6446921c8d7354f145ff9a2b9126789e04003a31b

See more details on using hashes here.

Supported by

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