Skip to content

rezadev8/namora

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Namora – AI Naming Assistant CLI

Namora is an AI-powered CLI tool to generate professional, concise, and meaningful names for variables, functions, classes, and constants.

It uses OpenAI or Ollama API to provide intelligent name suggestions based on your description and preferred naming style.


Table of Contents

  1. Installation
  2. Configuration
  3. Usage
  4. Commands
  5. Example

Installation

Prerequisites

  • Node.js >= 18
  • npm or yarn
  • Internet access
  • OpenAI API key or Ollama model

Install via npm

npm install -g namora-cli

Install via GitHub

git clone https://github.com/rezadev/namora.git
cd namora
npm install -g

After installation, you can run namora from anywhere in your terminal.


Configuration

Before using Namora, you need to configure API keys and preferences:

namora config

Options:

  • Set OpenAI API key Or Select Ollama
  • Set default model
  • Other preferences

View current config:

namora config:show

Reset config to defaults:

namora config:reset

Usage

Namora CLI takes a description of what you want to name and generates suggestions.

Basic Command

namora "Description of what you want to name" --type <type> --count <number> --case <case>

Options:

  • --type (-t): Type of name (variable, function, class, constant)
  • --count (-c): Number of suggestions
  • --case: Naming style (camel, snake, pascal, kebab, upper)

Commands

Command Description
namora config Set up or update configuration
namora config:show Show current configuration
namora config:reset Reset configuration
namora <description> Generate names with options --type, --count, --case

Example

namora "number of items in cart" -t variable -c 2 --case camel

Output:

cartItemCount
cartTotalItems

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published