To dokumentacja wersji 0.9.1. Najnowsza wersja to 0.9.2: przejdź do najnowszej dokumentacji
Instrukcja instalacji
2. Wymagania
- Model jest plikiem projektu EA .qea lub .qeax albo jest w bazie danych PostgreSQL, SQL Server, MySQL/MariaDB albo Oracle. Starsze formaty plików (.eap, .eapx, .feap) nie są obsługiwane; plik .eap/.eapx Enterprise Architect przekonwertuje do .qea transferem projektu (Settings → Model → Transfer → Full Project Transfer).
- Model w bazie ma włączone zabezpieczenia użytkowników (w Enterprise Architect: Settings → Security → Enable Security), w trybie „Require User Lock to Edit”. W pliku modelu zabezpieczenia są opcjonalne: bez nich asystent nie potrzebuje konta EA. Aplikacja loguje się do modelu na konto asystenta i na czas zapisu zakłada blokady. Gdy zabezpieczenia są wyłączone, blokady są pomijane, a taka konfiguracja nie jest obsługiwana. W aplikacji zaznaczasz to w karcie Model ustawień opcjami „Model ma włączone zabezpieczenia (konta użytkowników EA)” i „Model wymaga blokady do edycji (Require User Lock to Edit)” (rozdział 5).
- W modelu z włączonymi zabezpieczeniami istnieje konto użytkownika dla asystenta (Settings → Security → Users), z hasłem i z uprawnieniami do edycji. Nazwa konta jest dowolna, na przykład
claudealboasystent. Login i hasło tego konta podajesz w karcie Model ustawień, razem z plikiem albo bazą modelu.
| Co | Szczegóły |
|---|---|
| System | Windows 10 lub Windows 11 (64-bitowy) |
| Enterprise Architect | Zainstalowany na tym samym komputerze, z ważną licencją. Aplikacja uruchamia go w tle; w tym czasie zajmuje on jedno miejsce w licencji. Compass w EA (rozdział 10) pracuje w Twoim oknie EA. |
| Model EA | Plik projektu EA .qea lub .qeax (wystarczy jego ścieżka) albo repozytorium w bazie PostgreSQL z włączonymi zabezpieczeniami użytkowników (potrzebne są: serwer, port, nazwa bazy oraz konto i hasło do bazy, hasło bez średnika; tym kontem asystent czyta model, a Enterprise Architect zapisuje zmiany). Plik .qea jest przeznaczony dla jednej osoby, a .qeax dla małego zespołu, który współdzieli plik. Do użytku firmowego daj Compassowi rolę PostgreSQL z samym prawem SELECT na tabelach EA (t_*) i ustaw szyfrowanie połączenia na „Wymagane, z weryfikacją certyfikatu” (rozdział 5). Enterprise Architect zapisuje tym samym kontem, więc model, który asystent ma też zmieniać, wymaga na tych tabelach także INSERT, UPDATE i DELETE, nigdy uprawnień superużytkownika. Repozytorium w SQL Server, MySQL/MariaDB albo Oracle: te same dane i ta sama zasada dla konta (rozdział 5, „SQL Server, MySQL i Oracle”); do zapisu potrzebna jest edycja EA obsługująca repozytoria DBMS. |
| Sterownik ODBC (SQL Server, MySQL, Oracle) | Tylko dla modelu w SQL Server, MySQL/MariaDB albo Oracle: 64-bitowy sterownik ODBC producenta bazy. Dla SQL Server Windows ma już własny sterownik „SQL Server”; lepszy jest „ODBC Driver 18 for SQL Server” (albo 17) Microsoftu, używany w pierwszej kolejności, gdy jest zainstalowany. |
| Konto użytkownika modelu | Dla modelu w bazie albo pliku modelu z włączonymi zabezpieczeniami: login i hasło konta asystenta w modelu EA. Najlepiej osobne konto tylko dla asystenta, żeby jego zmiany i blokady było widać osobno i żeby nie kolidowały z Twoimi. |
| Klucz API | Klucz API Claude z konsoli Anthropic (Anthropic Console) albo, gdy wybierzesz dostawcę OpenAI, klucz API OpenAI z platformy OpenAI (rozdział 5). |
| Internet | Połączenie HTTPS z api.anthropic.com (albo z api.openai.com, gdy dostawcą jest OpenAI), także przez proxy z ustawień internetowych Windows (rozdział 18). |
| Uprawnienia administratora | Niepotrzebne przy instalacji „Tylko dla mnie”. Wymagane tylko przy instalacji dla wszystkich użytkowników komputera (rozdział 3). |
| Confluence (opcjonalnie) | Cloud albo Data Center, tylko do publikowania stron przez asystenta: adres, token i klucz przestrzeni (rozdział 13). Bez tego strony też powstają, a kod wklejasz sam. |
| Miro (opcjonalnie) | Tylko do wysyłania diagramów na tablicę Miro: token dostępu aplikacji Miro (rozdział 12). |
| Microsoft Office (opcjonalnie) | Tylko do plików PDF przygotowanych przez asystenta: Word zamienia na PDF dokument, a PowerPoint prezentację (rozdział 13). Same pliki Word i PowerPoint powstają bez Office. |
| SharePoint (opcjonalnie) | Tylko do dokumentów w bibliotece SharePoint zespołu: rejestracja aplikacji w Microsoft Entra ID z kluczem tajnym klienta (rozdział 13). |
| Node.js (opcjonalnie) | Tylko dla serwerów MCP uruchamianych przez npx, na przykład gotowych serwerów Azure DevOps i Files (rozdział 7). |
| Program pocztowy (opcjonalnie) | Program pocztowy ustawiony w Windows jako domyślny, na przykład Outlook: do zgłaszania błędów i zapisu na informacje o nowych wydaniach. |
3. Instalacja
Uruchom plik LoonarCompass-Setup-0.9.exe. Kreator prowadzi przez kolejne strony przyciskami Dalej i Wstecz. Uprawnień administratora nie potrzebujesz, chyba że instalujesz aplikację dla wszystkich użytkowników komputera.
- Język. Polski, angielski, niemiecki albo francuski. Przy nowej instalacji zaznaczony jest angielski, a przy aktualizacji język zapisany w Twoich ustawieniach. Wybrany język dotyczy kreatora, aplikacji, odpowiedzi asystenta i domyślnych szablonów dokumentów; później zmienisz go w ustawieniach (rozdział 5).
- Powitanie. Warunki konieczne i lista rzeczy, które warto przygotować przed instalacją.
- Co nowego. Przy aktualizacji: zmiany od zainstalowanej wersji. Przy nowej instalacji: najważniejsze zmiany w bieżącej wersji.
- Umowa licencyjna. Zaznacz „Akceptuję warunki umowy licencyjnej”.
- Statystyki użycia. Opcja „Wysyłaj anonimowe statystyki użycia (zalecane)” jest zaznaczona. Strona wyjaśnia, co jest wysyłane, a czego nigdy; Twój wybór możesz później zmienić w widoku „Statystyki użycia” (rozdział 18). Dane, które podawałeś wcześniej w kreatorze (klucz API, model, Enterprise Architect), wpisujesz teraz po pierwszym uruchomieniu w widoku „Ustawienia” (rozdział 5).
- Folder docelowy. Rodzaj instalacji (opisany niżej), folder programu i skróty: w menu Start (aplikacja, instrukcja użytkownika, odinstalowanie) i na pulpicie. Opcja „Dodaj Loonar Compass do Enterprise Architect” instaluje Compass w EA (rozdział 10); po instalacji uruchom EA ponownie.
- Gotowy do instalacji. Podsumowanie wyborów. Kliknij Instaluj; pasek postępu pokazuje procent i bieżący krok.
- Zakończenie. Zaznaczona opcja „Uruchom Loonar Compass” otwiera aplikację po kliknięciu Zakończ.
Rodzaj instalacji
Na stronie „Folder docelowy” wybierasz, dla kogo instalujesz aplikację:
- „Tylko dla mnie (zalecane, bez uprawnień administratora)”: program trafia do folderu
%LOCALAPPDATA%\Programs\Loonar Compass. Windows nie prosi o uprawnienia administratora. - „Dla wszystkich użytkowników tego komputera (wymaga uprawnień administratora)”: program trafia do folderu
%ProgramFiles%\Loonar Compass, w którym pliki mogą zmieniać tylko administratorzy. Windows prosi o uprawnienia administratora dopiero po kliknięciu Instaluj. Jeśli ich nie przyznasz, nic nie zostanie zainstalowane.
Ustawienia i hasła zawsze trafiają do profilu użytkownika, który uruchomił kreator, także wtedy, gdy uprawnienia administratora potwierdza inna osoba. Przy instalacji dla wszystkich użytkowników każdy z nich ma własne ustawienia, rozmowy i hasła.
Aktualizacja z wcześniejszej wersji
Wcześniejsze wersje aplikacji nosiły nazwę Loonar EA Assistant: Loonar Compass automatycznie przejmuje ich ustawienia, rozmowy, pamięć asystenta, szablony i hasła.
- Wcześniejsza wersja zainstalowana tylko dla Ciebie jest usuwana podczas instalacji (pliki programu, skróty i wpis w ustawieniach Windows); Twoje dane zostają.
- Wcześniejszą wersję zainstalowaną dla wszystkich użytkowników kreator pokazuje na stronie „Gotowy do instalacji”. Usuniesz ją przyciskiem Usuń starą wersję (uprawnienia administratora) albo później w ustawieniach Windows (Aplikacje). Twoje ustawienia i rozmowy zostają.
- Na pierwszej stronie kreator zaznacza język zapisany w Twoich ustawieniach (ustawienia bez zapisanego języka oznaczają polski), a gdy ustawień nie ma, angielski. Sprawdź ten wybór, zanim klikniesz Dalej.
- Zmiana języka w kreatorze nie tłumaczy pamięci asystenta ani szablonów. Jeśli chcesz je przenieść na nowy język, zostaw w kreatorze dotychczasowy język, a po instalacji zmień go w karcie „Język i zatwierdzanie zmian” ustawień (rozdział 5).
- Hasło do bazy, które starsze wersje trzymały w pliku ustawień, trafia do Menedżera poświadczeń Windows, a pliki z polskimi nazwami w folderze danych dostają nazwy angielskie (na przykład
audit_log.jsonlitemplates).
21. Aktualizacja i odinstalowanie
Aktualizacja. Zamknij aplikację i uruchom instalator nowszej wersji. Kreator pokaże stronę „Co nowego” ze zmianami od zainstalowanej wersji, zaproponuje ten sam rodzaj instalacji i folder oraz zachowa Twoje ustawienia, hasła, historię rozmów, załączniki, pamięć, szablony i dziennik zmian. Aktualizację z wersji o dawnej nazwie opisuje rozdział 3.
Informacja o nowej wersji. Co godzinę Compass sprawdza na GitHubie, czy jest nowsze wydanie, i pokazuje wtedy pasek u góry okna: Co nowego i pobieranie otwiera stronę wydania, Nie teraz ukrywa pasek do następnej wersji. W EA informacja pojawia się raz w zakładce „Loonar Compass” okna System Output. Compass niczego nie pobiera ani nie instaluje sam, a zapytanie nie zawiera identyfikatora instalacji. Sprawdzanie wyłączysz w Ustawienia → Nowe wydania (newsletter) albo kluczem app.update_check=false; administrator huba może je wyłączyć wszystkim ("update_check": false w polityce zespołu).
Zamykanie aplikacji. Zamknięcie okna zamyka też sesję Enterprise Architect uruchomioną w tle przez aplikację, więc licencja EA jest od razu zwalniana.
Odinstalowanie. Zamknij aplikację. Użyj skrótu „Odinstaluj Loonar Compass” w menu Start albo pozycji „Loonar Compass” w ustawieniach Windows (Aplikacje → Zainstalowane aplikacje). Przy instalacji dla wszystkich użytkowników Windows poprosi o uprawnienia administratora. Program odinstalowujący usuwa pliki programu, skróty i wpis w systemie, pokazując postęp na pasku. Twoje dane zostają na komputerze, chyba że zaznaczysz:
- „Usuń ustawienia, rozmowy, załączniki, pamięć asystenta, szablony dokumentów i dziennik zmian”: usuwa cały folder
%APPDATA%\Loonar Compass, - „Usuń klucz API, hasła i tokeny z Menedżera poświadczeń”: usuwa wszystkie sekrety aplikacji, także hasło do bazy i token Confluence.
Usuwane są tylko dane użytkownika, który uruchomił odinstalowanie; dane innych użytkowników zostają w ich profilach.