Skip to main content

Alfreds CLI

Project description

Alfreds CLI Tool

Alfreds (www.alfreds.ai) is the LLM platform for data teams. It enables data teams to create LLM agents that can be used in different stages of data workflows. Alfreds command-line tool allows data teams to install alfreds platform on their local machines and perform various tasks.

Prerequisites

  1. Python 3.6 or higher
  2. Docker
  3. Linux or macOS

Installation

To install alfreds, run the following command:

pip install alfreds

Usage

Alfreds can perform the following tasks:

  1. Initialize alfreds:

    alfreds init --agent_path {agent_absolute_path} --working_dir {working_dir_absolute_path} --seed_dir {seeds_absolute_path(optional)}
    

    This command initializes alfreds with the specified agent, working directory, and seeds (optional).
    Example:

     alfreds init --agent_path /Users/subu/alfreds/agent --working_dir /Users/subu/alfreds/working_dir --seed_dir /Users/subu/alfreds/seeds
    
  2. Update the agent:

    alfreds update_agent {agent_absolute_path}
    

    This command updates the agent with the specified absolute path.
    Example:

    alfreds update_agent /Users/subu/alfreds/agent
    
  3. Update the working directory:

    alfreds update_working_dir {working_dir_absolute_path}
    

    This command updates the working directory with the specified absolute path.

  4. Seed the application:

    alfreds seed {seed dir/csv file absolute path}
    

    This command seeds the application with the specified seed directory or CSV file.

  5. Stop alfreds:

    alfreds stop
    

    This command stops the alfreds application.

  6. Start alfreds:

    alfreds start
    

    This command starts the alfreds application.

  7. Refresh alfreds:

    alfreds refresh
    

    This command refreshes the alfreds application.

  8. Alfreds Help:

    alfreds --help
    

    This command displays the help menu for alfreds.

Please note that you need to provide the absolute paths for the agent, working directory, and seeds when using the respective commands.

If you have any questions or need further assistance, please refer to the alfreds documentation or contact our support team.

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

alfreds-0.0.14-py3-none-any.whl (9.3 kB view hashes)

Uploaded Python 3

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