SKonsole 1.1.2
dotnet tool install --global SKonsole --version 1.1.2
dotnet new tool-manifest # if you are setting up this repo dotnet tool install --local SKonsole --version 1.1.2
#tool dotnet:?package=SKonsole&version=1.1.2
nuke :add-package SKonsole --version 1.1.2
SKonsole - A Console App built on Semantic Plugins
Welcome to the SKonsole repository! SKonsole is a powerful command-line tool that leverages AI to assist you with various tasks. It provides a simple interface to interact with the AI model and perform operations like reading and writing files, searching for files, and even sending emails. The repository contains the source code for the SKonsole application and its plugins.
Features
- AI-powered command-line interface
- Customizable configuration
- Generate commit messages, pull request descriptions, and feedback.
- Engage in chat conversations that are powered by various Plugins.
Usage
General Commands
These commands will execute and return a result from the LLM.
skonsole commit <commitHash>
: Generate commit messages based on the provided commit hash.
skonsole pr feedback
: Generate valuable feedback for pull requests using git diff or git show output.
skonsole pr description
: Generate detailed descriptions for pull requests using git diff or git show output.
Chat Commands
These commands will start a chat conversation with the LLM.
skonsole stepwise [options]
: Engage in a StepwisePlanner powered chat session. Use optionSet
option to specify which optionSets should be used for planning.
skonsole createPlan <message>
: Create plans using a Planner by providing a message and then execute the plan.
skonsole promptChat
: Engage in interactive prompt chat sessions for building semantic prompts using the LLM.
Other Commands
These commands are other utilities that do not directly leverage LLMs.
skonsole config [command] [options]
: Configure SKonsole application settings like LLM endpoints, keys, etc.
Configuration
You can customize the behavior of SKonsole by modifying the configuration settings. In addition to the config
command, the configuration file is located at .skonsole
in your user profile directory. You can also set environment variables to override the default settings.
Installing SKonsole Tool
Install the SKonsole Tool globally with a few quick steps:
Installation
Open your terminal or command prompt.
Run the following command:
dotnet tool install --global SKonsole
To confirm the installation was successful, run:
skonsole --version
Plugins
The repository includes the following plugins:
CondensePlugin
The CondensePlugin is designed to help condense text by using the LLM to merge multiple chunks of text.
PRPlugin
The PRPlugin is designed to help generate pull request summaries and change lists from git diff
output.
SuperFileIOPlugin
The SuperFileIOPlugin is an extension of the FileIOPlugin in Semantic Kernel. It includes additional capabilities for reading and writing from the file system.
Contributing
See Contributing.
License
SKonsole is licensed under the MIT License.
Powered by Microsoft Semantic Kernel
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
This package has no dependencies.