Skip to content

Latest commit

 

History

History
120 lines (78 loc) · 7.18 KB

configuration.md

File metadata and controls

120 lines (78 loc) · 7.18 KB

用語定義(わかりにくくなってきたのでじき修正します)

システム用語 魔法体系 説明 自然言語プログラミング体系
インタプリタ実行 即時魔法 対話形式の自然言語による指示のこと。即座に魔法を発動できる。 zoltraak 魔導書
コンパイラ実行 錬成魔法 ドキュメント形式で記述された魔法の定義のこと。じっくりと魔法を錬成できる。 zoltraak 魔導書 --prompt 呪文
コンパイラ 錬成器、起動式 詠唱から魔導書、魔法陣を錬成するための道具のこと。 錬成機自体は起動式が記述されている。魔法の品質を高めるのに役立つ。 zoltraak -c 錬成器
自然言語プログラム 魔導書、魔法式、術式 魔法の理論や使い方を体系的にまとめた書物のこと。魔法の学習に役立ちこれ自体は一般言語で執筆されている。zoltraakにより魔法を発動することも出来る。 zoltraak 魔導書
高級言語プログラム 古代魔導書 太古の魔法使いたちが残した神秘的な書物。ルーン文字で書かれており、強力な魔法の秘密が記されている。解読は容易ではないが、魔法の真髄を学ぶことができる。 zoltraak -a 古代魔導書
機械語 魔法石 魔導書を錬成器で錬成したもの、魔導書を実行すると魔法石により魔法が発動する zoltraak -c 魔法石.md

文字

システム用語 魔法体系 説明
自然言語 世界語 人間が日常的に使用する言語。自然に発生し、文法や語彙が複雑。魔法を唱えるのに使われる。
プログラミング言語 古代語 魔法を正確に記述するための言語。厳密な文法と限られた語彙を持つ。魔導書の記述に使われる。

術式

術式 説明
起動術式 魔法術式を構築するための術式
魔法術式 イメージを具体的に記した術式のこと
魔法陣 魔法術式の中でも視覚情報は魔法陣と呼ぶ
領域術式 魔法術式を得て領域を具現化する術式
視覚術式 魔法術式を得て領域を具現化する術式、魔導書に相当する魔法術式は文字情報が多いため、視覚化する目的でも利用する

主な機能(予定)

  • マークダウンファイルから様々な高級言語のコードへの変換
    • 対応言語: Python, Java, C++, JavaScript, TypeScriptなど
  • AnthropicのClaude AIモデルを利用したコード生成
  • 変換済みファイルのキャッシュによる高速な再実行
  • 進捗状況の追跡とテストケースの実行
  • CI/CDワークフローとの統合
プロンプト ドキュメント 高級言語
ファイルなし zoltraak docs --prompt text zoltraak docs zoltraak docs
ファイルあり (修正変更なし) zoltraak docs --prompt text zoltraak docs zoltraak docs
ファイルあり (修正変更あり) zoltraak docs --prompt text zoltraak docs zoltraak docs

この表では、各セルに zoltraak {ファイル名} の形式でファイル名を入れています。

  • 左側の列は、ファイルの有無とファイルの状態を表しています。

    1. ファイルなし
    2. ファイルあり (修正変更なし)
    3. ファイルあり (修正変更あり)
  • 上側の行は、ファイルの種類とその説明を表しています。

    • テキストファイル (読み上げ文章)
    • マークダウンファイル (要件定義書)
    • Pythonファイル (高級言語)

各セルには、対応するファイルの種類に基づいて zoltraak 読み上げ文章zoltraak 要件定義書zoltraak 高級言語 のようなコマンドが入っています

この表は、ファイルの有無とファイルの状態の関係性を明確に表現しており、ファイルの種類ごとにそれぞれの状態が適用可能であることを示しています。また、各セルにファイル名を入れることで、具体的なファイルの例を提供しています。

オプション(Option)

Zoltraakには以下のようなオプションが用意されています。

  • --output-dir: 生成されたPythonファイルの出力ディレクトリを指定します。デフォルトは"generated"ディレクトリです。
  • -p, --prompt: 追加のプロンプト情報を指定します。これにより、既存のMarkdownファイルに対して変更を提案したり、新しい要件定義書を生成することができます。
  • -c, --compiler: 要件定義書のテンプレートとなるMarkdownファイルのパスを指定します。デフォルトは"reqdef.md"です。

これらのオプションを使うことで、Zoltraakの機能をより柔軟に活用できます。例えば、既存のMarkdownファイルに対して変更を提案したり、新しい要件定義書を生成することができます。

また、要件定義書のテンプレートとなるMarkdownファイルを変更することで、生成される要件定義書の形式を変更することも可能です。

様々なプログラミング言語でのZoltraakの利用方法(作成予定)

Zoltraakは様々なプログラミング言語のファイルを処理することができます。以下に主要な言語での利用例を示します。

ファイル作成 &

# 様々な言語でzoltraak を試してみよう

## Python
zoltraak script.py -p "ユーザー情報を管理するクラスを作成したい"
zoltraak utils.py -p "CSVファイルを読み込んでデータを処理する関数が必要"

## JavaScript
zoltraak app.js -p "TODOリストを管理するReactコンポーネントが必要"
zoltraak server.js -p "ExpressでRESTful APIを実装したい"

## Java  
zoltraak Main.java -p "学生の成績を計算するメソッドを追加してほしい"
zoltraak UserService.java -p "ユーザーのCRUD操作を行うメソッドを作成"

## C++
zoltraak main.cpp -p "リンクリストを使ってデータを管理する関数を書きたい" 
zoltraak utils.h -p "数学計算用のユーティリティ関数を定義したい"

## Ruby
zoltraak app.rb -p "ユーザー認証機能を実装したい"
zoltraak parser.rb -p "JSONデータをパースしてオブジェクトに変換する機能が欲しい"

上記は一例ですが、このようにzoltraak を使えば様々な言語やシチュエーションでコード生成ができます。
ぜひ色々なプロンプトを試して、zoltraak の可能性を探ってみてください!

実行

このように、zoltraak は対象となるファイルの拡張子から言語を判断し、適切な形式でコードを生成します。プロンプトには自然言語で実現したい機能や要件を記述するだけで、zoltraak が自動的にコードを生成してくれます。 プログラミング言語に関わらず、同じようにzoltraak を使うことができるため、様々なプロジェクトで活用できるでしょう。