Skip to content

Latest commit

 

History

History
155 lines (101 loc) · 3.94 KB

File metadata and controls

155 lines (101 loc) · 3.94 KB

text.jpg

Quickstart

First of all, thank you for trying Hackerman Text!

Hackerman Text is free for personal or evaluation purposes (non-commercial only). We are 100% user-funded, so please consider purchasing a license to support continued development.

Commercial use requires a license. You can buy one here: https://hackerman.ai/

How to setup code completion

Code completion can be triggered with Code Completion (Cmd + K).

Ollama

Hackerman Text can run some FIM/next-edit models via Ollama for very fast and 100% local code completion.

You need to install Ollama, and download one of the recommended models (such as https://ollama.com/library/qwen2.5-coder).

Update your .hackerman config file (Right-Click or Cmd+Shift+P to open function explorer, select Open Config File):

[models]
code_completion                     ollama, qwen2.5-coder:1.5b

Mistral

Create an account and get your api key, see https://docs.mistral.ai/getting-started/quickstart.

Export your api key as an environment variable in your terminal.

export MISTRAL_API_KEY=YOUR_KEY_HERE

Update your .hackerman config file (Right-Click or Cmd+Shift+P to open function explorer, select Open Config File):

[models]
code_completion                     mistral

Inception

Create an account and get your api key, see https://docs.inceptionlabs.ai/get-started/authentication.

Export your api key as an environment variable in your terminal.

export INCEPTION_API_KEY=YOUR_KEY_HERE

Update your .hackerman config file (Right-Click or Cmd+Shift+P to open function explorer, select Open Config File):

[models]
code_completion                     inception

Inline commands

Hackerman Text support running shell commands and evaluating Python expressions in any file.

Inline commands can be triggered with Inline Commands (Cmd + Shift + Return) in allowed files. By default, allowed files are txt and md.

% echo 'hello'
hello
42**42
150130937545296572356771972164254457814047970568738777235893533016064

Org-mode code execution

Hackerman Text support code execution in Org files.

Python

def main(name):
    print(f"Welcome to Python in org-mode, { name }!")
main(name)

Moving cursor into this code block and running Inline Command (Cmd + Shift + Return) will generate the below results.

#+RESULTS: True
: Welcome to Python in org-mode, Michael!

Lua

local function main(name)
    print("Welcome to Lua in org-mode, " .. name .. "!")
end
main(name)

Moving cursor into this code block and running Inline Command (Cmd + Shift + Return) will generate the below results.

#+RESULTS: True
: Welcome to Lua in org-mode, Michael!

JavaScript

function main(name){
    console.log(`Welcome to JavaScript in org-mode, ${name}!`);
}
main(name);

Moving cursor into this code block and running Inline Command (Cmd + Shift + Return) will generate the below results.

#+RESULTS: True
: Welcome to JavaScript in org-mode, Michael!

Hy

(defn main [name]
    (print "Welcome to Hy in org-mode," name "!")
)
(main name)

Moving cursor into this code block and running Inline Command (Cmd + Shift + Return) will generate the below results.

#+RESULTS: True
: Welcome to Hy in org-mode, Michael !