Quick Start Guide for Admin Assist CLI

Get started with Admin Assist CLI. Learn how to install, configure, and use our AI-powered administrative assistant platform.

Welcome to the Admin Assist CLI! This guide will help you quickly set up and start using the CLI for your development and content creation tasks.

Getting Started

Follow these steps to get started with the Admin Assist CLI.

1. Initial Setup

1

Clone the Repository

git clone https://github.com/yourusername/admin-assist-cli.git
cd admin-assist-cli
2

Install Dependencies

Ensure you have Python and pip installed. Then, run:

pip install -r requirements.txt
3

Set Up Your Environment

Currently, there is no API key setup required for the CLI to function.

2. Basic Commands

Interactive AI Chat

1

Start a Conversation

Start a conversation with the AI assistant.

Usage:

python src/cli/main.py chat

Options:

  • --websearch: Enable or disable web search.
  • --model: Specify the OpenAI model to use (default is gpt-3.5-turbo).
  • --save: Save the conversation to a specified file.

Example:

python src/cli/main.py chat --websearch --model gpt-4 --save conversation.json

Transcribe Audio Files

1

Audio Transcription

Transcribe audio files and generate structured notes.

Usage:

admin-assist transcribe <file_path>

Options:

  • --format: Specify the output format (text, json, markdown).

Example:

admin-assist transcribe audio_file.mp3 --format markdown

Execute or Analyze Code

1

Code Analysis

Analyze a code file or execute it if supported.

Usage:

admin-assist execute_code <code_file> [--language <language>]

Options:

  • --language: Specify the programming language if not detected automatically.

Example:

admin-assist execute_code script.py --language python

Run Tasks from a File

1

Task Execution

Run a series of predefined tasks from a JSON file.

Usage:

admin-assist run_tasks <task_file>

Example:

admin-assist run_tasks tasks.json

Create Documents

1

Document Creation

Create a new document with AI assistance based on specified objectives.

Usage:

admin-assist create_document

Options:

  • --type: Specify the type of document (e.g., Document, Research Report).
  • --objective: Provide the objective of the document.
  • --websearch: Perform a web search for background research.

Example:

admin-assist create_document --type "Research Report" --objective "Analyze the impact of AI on education" --websearch

Create or Improve Applications

1

Application Development

Create a new application or improve an existing one with AI assistance.

Usage:

admin-assist create_application

Options:

  • --language: Specify the programming language (e.g., Python, JavaScript).
  • --objective: Provide the objective of the application.
  • --mode: Choose to create a new application or improve an existing one.
  • --project-dir: Specify the directory for the project.

Example:

admin-assist create_application --language Python --objective "Build a web scraper" --mode Create --project-dir my_scraper

Terminal Usage

1

Basic Usage

Input the following text in the terminal:

python src/cli/main.py

Available commands:

  • chat: Start an interactive chat session
  • create-code: Generate code based on requirements and specifications
  • create-document: Create a document based on requirements
  • run-tasks: Run a series of tasks from a file
  • transcribe: Transcribe an audio file and generate notes
  • version: Show version information

Getting Help

1

Access Help

If you need assistance:

  1. Check the Documentation

    admin-assist docs open

  2. Get Command-Specific Help

    admin-assist COMMAND --help

  3. Access the Interactive Help System

    admin-assist help interactive

Next Steps

Documentation
Examples
Best Practices

Support:

Need help? Check our documentation or join our GitHub Discussions.